Penguin
Annotated edit history of udp(7) version 4, including all changes. View license author blame.
Rev Author # Line
1 perry 1 udp - User Datagram Protocol for IPv4
2 !!SYNOPSIS
3 #include <sys/socket.h>
2 KitPeters 4 #include <netinet/in.h>
5
6 udp_socket = socket(PF_INET, SOCK_DGRAM, 0);
3 PerryLorier 7
1 perry 8 !!DESCRIPTION
3 PerryLorier 9 This is an implemention of the User Datagram Protocol described in RFC768. It implements a connectionless, unreliable datagram packet service. Packets may be reordered
10 or duplicated before they arrive. UDP generates and checks checksums to catch transmission errors.
1 perry 11
3 PerryLorier 12 When a UDP socket is created, its local and remote addresses are unspecified. Datagrams can be sent immediately using sendto(2) or sendmsg(2) with a valid
13 destination address as an argument. When connect(2) is called on the socket the default destination address is set and datagrams can now be sent using send(2) or
14 write(2) without specifying an destination address. It is still possible to send to other destinations by passing an address to sendto(2) or sendmsg(2).
15 In order to receive packets the socket can be bound to an local address first by using bind(2). Otherwise the socket layer will automatically assign a free local port out of the range defined by ''net.ipv4.ip_local_port_range'' and bind the socket to ''INADDR_ANY''.
1 perry 16
3 PerryLorier 17 All receive operations return only one packet. When the packet is smaller than the passed buffer only that much data is returned, when it is bigger the packet is truncated and the __MSG_TRUNC__ flag is set. ''MSG_WAITALL'' is not supported.
1 perry 18
3 PerryLorier 19 IP options may be sent or received using the socket options described in ip(7). They are only processed by the kernel when the appropriate sysctl is enabled (but still
20 passed to the user even when it is turned off). See ip(7).
1 perry 21
3 PerryLorier 22 When the __MSG_DONTROUTE__ flag is set on sending the destination address must refer to an local interface address and the packet is only sent to that interface.
1 perry 23
3 PerryLorier 24 UDP fragments a packet when its total length exceeds the interface [MTU] (Maximum Transmission Unit). A more network friendly alternative is to use path MTU discovery as described in the __IP_PMTU_DISCOVER__ section of ip(7).
1 perry 25
26 !!ADDRESS FORMAT
3 PerryLorier 27 UDP uses the IPv4 __sockaddr_in__ address format described in ip(7).
1 perry 28
29 !!ERROR HANDLING
3 PerryLorier 30 All fatal errors will be passed to the user as an error return even when the socket is not connected. This includes asynchronous errors received from the network. You may get an error for an earlier packet that was sent on the same socket. This behaviour differs from many other BSD socket implementations which don't pass any errors unless the socket is connected. Linux's behaviour is mandated by RFC:1122 .
1 perry 31
3 PerryLorier 32 For compatibility with legacy code it is possible to set the __SO_BSDCOMPAT__ SOL_SOCKET option to receive remote errors only when the socket has been connected (except for __EPROTO__ and __EMSGSIZE__). It is better to fix the code to handle errors properly than to enable this option. Locally generated errors are always passed.
1 perry 33
3 PerryLorier 34 When the __IP_RECVERR__ option is enabled all errors are stored in the socket error queue and can be received by recvmsg(2) with the __MSG_ERRQUEUE__ flag
35 set.
1 perry 36
37 !!IOCTLS
38
39
40 These ioctls can be accessed using ioctl(2). The
41 correct syntax is:
42
43
3 PerryLorier 44 __int__ ''value''__;
45 __''error'' __= ioctl(__''tcp_socket''__,__ ''ioctl_type''__, __''value''__);__
1 perry 46
47
4 PerryLorier 48 ;__SIOCINQ__:Gets a pointer to an integer as argument. Returns the size of the next pending datagram in the integer in bytes, or 0 when no datagram is pending.
1 perry 49
2 KitPeters 50 *** NOTE: 2003/07/03 SIOCINQ is undefined in Linux 2.4.20 / glibc 2.3.1 (Kit Peters) ***
1 perry 51
4 PerryLorier 52 ;__SIOCOUTQ__: Returns the number of data bytes in the local send queue. Only supported with Linux 2.4 and above.
1 perry 53
3 PerryLorier 54 In addition all ioctls documented in ip(7) and socket(7) are supported.
1 perry 55
56 !!ERRORS
3 PerryLorier 57 All errors documented for socket(7) or ip(7) may be returned by a send or receive on a [UDP] socket.
1 perry 58
59
3 PerryLorier 60 ;[ECONNREFUSED]: No receiver was associated with the destination address. This might be caused by a previous packet sent over the socket.
1 perry 61
62 !!VERSIONS
3 PerryLorier 63 IP_RECVERR is a new feature in Linux 2.2
1 perry 64
65 !!CREDITS
3 PerryLorier 66 This man page was written by Andi Kleen.
1 perry 67
68 !!SEE ALSO
3 PerryLorier 69 ip(7), socket(7), raw(7), [UDP], tcp(7)
1 perry 70
71
3 PerryLorier 72 RFC:768 for the User Datagram protocol. RFC:1122 for the host requirements. RFC:1191 for a description of path [MTU]
1 perry 73 discovery.
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.

PHP Warning

lib/blame.php:177: Warning: Invalid argument supplied for foreach() (...repeated 10 times)