Changes in uspace/srv/net/tl/udp/udp_header.h [457a6f5:aadf01e] in mainline

File:

• uspace/srv/net/tl/udp/udp_header.h (modified) (1 diff)

uspace/srv/net/tl/udp/udp_header.h

@@ -28 +28 @@
 
 /** @addtogroup udp
- * @{
+ *  @{
  */
 
 /** @file
- * UDP header definition.
- * Based on the RFC 768.
+ *  UDP header definition.
+ *  Based on the RFC~768.
  */
 
-#ifndef NET_UDP_HEADER_H_
-#define NET_UDP_HEADER_H_
+#ifndef __NET_UDP_HEADER_H__
+#define __NET_UDP_HEADER_H__
 
 #include <sys/types.h>
 
-/** UDP header size in bytes. */
-#define UDP_HEADER_SIZE         sizeof(udp_header_t)
+/** UDP header size in bytes.
+ */
+#define UDP_HEADER_SIZE                 sizeof(udp_header_t)
 
 /** Type definition of the user datagram header.
- * @see udp_header
+ *  @see udp_header
  */
-typedef struct udp_header udp_header_t;
+typedef struct udp_header       udp_header_t;
 
 /** Type definition of the user datagram header pointer.
- * @see udp_header
+ *  @see udp_header
  */
-typedef udp_header_t *udp_header_ref;
+typedef udp_header_t *          udp_header_ref;
 
-/** User datagram header. */
-struct udp_header {
+/** User datagram header.
+ */
+struct udp_header{
+        /** Source Port is an optional field, when meaningful, it indicates the port of the sending process, and may be assumed to be the port to which a reply should be addressed in the absence of any other information.
+         *  If not used, a value of zero is inserted.
+         */
         uint16_t source_port;
+        /** Destination port has a meaning within the context of a particular internet destination address.
+         */
         uint16_t destination_port;
+        /** Length is the length in octets of this user datagram including this header and the data.
+         *  This means the minimum value of the length is eight.
+         */
         uint16_t total_length;
+        /** Checksum is the 16-bit one's complement of the one's complement sum of a pseudo header of information from the IP header, the UDP header, and the data, padded with zero octets at the end (if necessary) to make a multiple of two octets.
+         *  The pseudo header conceptually prefixed to the UDP header contains the source address, the destination address, the protocol, and the UDP length.
+         *  This information gives protection against misrouted datagrams.
+         *  If the computed checksum is zero, it is transmitted as all ones (the equivalent in one's complement arithmetic).
+         *  An all zero transmitted checksum value means that the transmitter generated no checksum (for debugging or for higher level protocols that don't care).
+         */
         uint16_t checksum;
 } __attribute__ ((packed));