share/man/man4/udp.4

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)udp.4       8.1 (Berkeley) 6/5/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd February 6, 2017
  32 .Dt UDP 4
  33 .Os
  34 .Sh NAME
  35 .Nm udp
  36 .Nd Internet User Datagram Protocol
  37 .Sh SYNOPSIS
  38 .In sys/types.h
  39 .In sys/socket.h
  40 .In netinet/in.h
  41 .Ft int
  42 .Fn socket AF_INET SOCK_DGRAM 0
  43 .Sh DESCRIPTION
  44 .Tn UDP
  45 is a simple, unreliable datagram protocol which is used
  46 to support the
  47 .Dv SOCK_DGRAM
  48 abstraction for the Internet
  49 protocol family.
  50 .Tn UDP
  51 sockets are connectionless, and are
  52 normally used with the
  53 .Xr sendto 2
  54 and
  55 .Xr recvfrom 2
  56 calls, though the
  57 .Xr connect 2
  58 call may also be used to fix the destination for future
  59 packets (in which case the
  60 .Xr recv 2
  61 or
  62 .Xr read 2
  63 and
  64 .Xr send 2
  65 or
  66 .Xr write 2
  67 system calls may be used).
  68 .Pp
  69 .Tn UDP
  70 address formats are identical to those used by
  71 .Tn TCP .
  72 In particular
  73 .Tn UDP
  74 provides a port identifier in addition
  75 to the normal Internet address format.
  76 Note that the
  77 .Tn UDP
  78 port
  79 space is separate from the
  80 .Tn TCP
  81 port space (i.e., a
  82 .Tn UDP
  83 port
  84 may not be
  85 .Dq connected
  86 to a
  87 .Tn TCP
  88 port).
  89 In addition broadcast
  90 packets may be sent (assuming the underlying network supports
  91 this) by using a reserved
  92 .Dq broadcast address ;
  93 this address
  94 is network interface dependent.
  95 .Pp
  96 Options at the
  97 .Tn IP
  98 transport level may be used with
  99 .Tn UDP ;
 100 see
 101 .Xr ip 4 .
 102 .Tn UDP_ENCAP
 103 socket option may be used at the
 104 .Tn IPPROTO_UDP
 105 level to encapsulate
 106 .Tn ESP
 107 packets in
 108 .Tn UDP .
 109 Only one value is supported for this option:
 110 .Tn UDP_ENCAP_ESPINUDP
 111 from RFC 3948, defined in
 112 .In netinet/udp.h .
 113 .Sh MIB VARIABLES
 114 The
 115 .Nm
 116 protocol implements a number of variables in the
 117 .Li net.inet
 118 branch of the
 119 .Xr sysctl 3
 120 MIB.
 121 .Bl -tag -width UDPCTL_RECVSPACEX
 122 .It UDPCTL_CHECKSUM
 123 .Pq udp.checksum
 124 Enable udp checksums (enabled by default).
 125 .It UDPCTL_MAXDGRAM
 126 .Pq udp.maxdgram
 127 Maximum outgoing UDP datagram size
 128 .It UDPCTL_RECVSPACE
 129 .Pq udp.recvspace
 130 Maximum space for incoming UDP datagrams
 131 .It udp.log_in_vain
 132 For all udp datagrams, to ports on which there is no socket
 133 listening, log the connection attempt (disabled by default).
 134 .It udp.blackhole
 135 When a datagram is received on a port where there is no socket
 136 listening, do not return an ICMP port unreachable message.
 137 (Disabled by default.
 138 See
 139 .Xr blackhole 4 . )
 140 .El
 141 .Sh ERRORS
 142 A socket operation may fail with one of the following errors returned:
 143 .Bl -tag -width Er
 144 .It Bq Er EISCONN
 145 when trying to establish a connection on a socket which
 146 already has one, or when trying to send a datagram with the destination
 147 address specified and the socket is already connected;
 148 .It Bq Er ENOTCONN
 149 when trying to send a datagram, but
 150 no destination address is specified, and the socket has not been
 151 connected;
 152 .It Bq Er ENOBUFS
 153 when the system runs out of memory for
 154 an internal data structure;
 155 .It Bq Er EADDRINUSE
 156 when an attempt
 157 is made to create a socket with a port which has already been
 158 allocated;
 159 .It Bq Er EADDRNOTAVAIL
 160 when an attempt is made to create a
 161 socket with a network address for which no network interface
 162 exists.
 163 .El
 164 .Sh SEE ALSO
 165 .Xr getsockopt 2 ,
 166 .Xr recv 2 ,
 167 .Xr send 2 ,
 168 .Xr socket 2 ,
 169 .Xr blackhole 4 ,
 170 .Xr inet 4 ,
 171 .Xr intro 4 ,
 172 .Xr ip 4 ,
 173 .Xr udplite 4
 174 .Sh HISTORY
 175 The
 176 .Nm
 177 protocol appeared in
 178 .Bx 4.2 .