lib/libc/sys/send.2

   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 .\"     From: @(#)send.2        8.2 (Berkeley) 2/21/94
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd August 19, 2018
  32 .Dt SEND 2
  33 .Os
  34 .Sh NAME
  35 .Nm send ,
  36 .Nm sendto ,
  37 .Nm sendmsg ,
  38 .Nm sendmmsg
  39 .Nd send message(s) from a socket
  40 .Sh LIBRARY
  41 .Lb libc
  42 .Sh SYNOPSIS
  43 .In sys/socket.h
  44 .Ft ssize_t
  45 .Fn send "int s" "const void *msg" "size_t len" "int flags"
  46 .Ft ssize_t
  47 .Fn sendto "int s" "const void *msg" "size_t len" "int flags" "const struct sockaddr *to" "socklen_t tolen"
  48 .Ft ssize_t
  49 .Fn sendmsg "int s" "const struct msghdr *msg" "int flags"
  50 .Ft ssize_t
  51 .Fn sendmmsg "int s" "struct mmsghdr * restrict msgvec" "size_t vlen" "int flags"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn send
  55 and
  56 .Fn sendmmsg
  57 functions,
  58 and
  59 .Fn sendto
  60 and
  61 .Fn sendmsg
  62 system calls
  63 are used to transmit one or more messages (with the
  64 .Fn sendmmsg
  65 call) to
  66 another socket.
  67 The
  68 .Fn send
  69 function
  70 may be used only when the socket is in a
  71 .Em connected
  72 state, while
  73 .Fn sendto ,
  74 .Fn sendmsg
  75 and
  76 .Fn sendmmsg
  77 may be used at any time.
  78 .Pp
  79 The address of the target is given by
  80 .Fa to
  81 with
  82 .Fa tolen
  83 specifying its size.
  84 The length of the message is given by
  85 .Fa len .
  86 If the message is too long to pass atomically through the
  87 underlying protocol, the error
  88 .Er EMSGSIZE
  89 is returned, and
  90 the message is not transmitted.
  91 .Pp
  92 The
  93 .Fn sendmmsg
  94 function sends multiple messages at a call.
  95 They are given by the
  96 .Fa msgvec
  97 vector along with
  98 .Fa vlen
  99 specifying the vector size.
 100 The number of octets sent per each message is placed in the
 101 .Fa msg_len
 102 field of each processed element of the vector after transmission.
 103 .Pp
 104 No indication of failure to deliver is implicit in a
 105 .Fn send .
 106 Locally detected errors are indicated by a return value of -1.
 107 .Pp
 108 If no messages space is available at the socket to hold
 109 the message to be transmitted, then
 110 .Fn send
 111 normally blocks, unless the socket has been placed in
 112 non-blocking I/O mode.
 113 The
 114 .Xr select 2
 115 system call may be used to determine when it is possible to
 116 send more data.
 117 .Pp
 118 The
 119 .Fa flags
 120 argument may include one or more of the following:
 121 .Bd -literal
 122 #define MSG_OOB         0x00001 /* process out-of-band data */
 123 #define MSG_DONTROUTE   0x00004 /* bypass routing, use direct interface */
 124 #define MSG_EOR         0x00008 /* data completes record */
 125 #define MSG_EOF         0x00100 /* data completes transaction */
 126 #define MSG_NOSIGNAL    0x20000 /* do not generate SIGPIPE on EOF */
 127 .Ed
 128 .Pp
 129 The flag
 130 .Dv MSG_OOB
 131 is used to send
 132 .Dq out-of-band
 133 data on sockets that support this notion (e.g.\&
 134 .Dv SOCK_STREAM ) ;
 135 the underlying protocol must also support
 136 .Dq out-of-band
 137 data.
 138 .Dv MSG_EOR
 139 is used to indicate a record mark for protocols which support the
 140 concept.
 141 .Dv MSG_EOF
 142 requests that the sender side of a socket be shut down, and that an
 143 appropriate indication be sent at the end of the specified data;
 144 this flag is only implemented for
 145 .Dv SOCK_STREAM
 146 sockets in the
 147 .Dv PF_INET
 148 protocol family.
 149 .Dv MSG_DONTROUTE
 150 is usually used only by diagnostic or routing programs.
 151 .Dv MSG_NOSIGNAL
 152 is used to prevent
 153 .Dv SIGPIPE
 154 generation when writing a socket that
 155 may be closed.
 156 .Pp
 157 See
 158 .Xr recv 2
 159 for a description of the
 160 .Fa msghdr
 161 structure and the
 162 .Fa mmsghdr
 163 structure.
 164 .Sh RETURN VALUES
 165 The
 166 .Fn send ,
 167 .Fn sendto
 168 and
 169 .Fn sendmsg
 170 calls
 171 return the number of octets sent.
 172 The
 173 .Fn sendmmsg
 174 call returns the number of messages sent.
 175 If an error occurred a value of -1 is returned.
 176 .Sh ERRORS
 177 The
 178 .Fn send
 179 and
 180 .Fn sendmmsg
 181 functions and
 182 .Fn sendto
 183 and
 184 .Fn sendmsg
 185 system calls
 186 fail if:
 187 .Bl -tag -width Er
 188 .It Bq Er EBADF
 189 An invalid descriptor was specified.
 190 .It Bq Er EACCES
 191 The destination address is a broadcast address, and
 192 .Dv SO_BROADCAST
 193 has not been set on the socket.
 194 .It Bq Er ENOTSOCK
 195 The argument
 196 .Fa s
 197 is not a socket.
 198 .It Bq Er EFAULT
 199 An invalid user space address was specified for an argument.
 200 .It Bq Er EMSGSIZE
 201 The socket requires that message be sent atomically,
 202 and the size of the message to be sent made this impossible.
 203 .It Bq Er EAGAIN
 204 The socket is marked non-blocking and the requested operation
 205 would block.
 206 .It Bq Er ENOBUFS
 207 The system was unable to allocate an internal buffer.
 208 The operation may succeed when buffers become available.
 209 .It Bq Er ENOBUFS
 210 The output queue for a network interface was full.
 211 This generally indicates that the interface has stopped sending,
 212 but may be caused by transient congestion.
 213 .It Bq Er EHOSTUNREACH
 214 The remote host was unreachable.
 215 .It Bq Er EISCONN
 216 A destination address was specified and the socket is already connected.
 217 .It Bq Er ECONNREFUSED
 218 The socket received an ICMP destination unreachable message
 219 from the last message sent.
 220 This typically means that the
 221 receiver is not listening on the remote port.
 222 .It Bq Er EHOSTDOWN
 223 The remote host was down.
 224 .It Bq Er ENETDOWN
 225 The remote network was down.
 226 .It Bq Er EADDRNOTAVAIL
 227 The process using a
 228 .Dv SOCK_RAW
 229 socket was jailed and the source
 230 address specified in the IP header did not match the IP
 231 address bound to the prison.
 232 .It Bq Er EPIPE
 233 The socket is unable to send anymore data
 234 .Dv ( SBS_CANTSENDMORE
 235 has been set on the socket).
 236 This typically means that the socket
 237 is not connected.
 238 .El
 239 .Sh SEE ALSO
 240 .Xr fcntl 2 ,
 241 .Xr getsockopt 2 ,
 242 .Xr recv 2 ,
 243 .Xr select 2 ,
 244 .Xr socket 2 ,
 245 .Xr write 2 ,
 246 .Xr CMSG_DATA 3
 247 .Sh HISTORY
 248 The
 249 .Fn send
 250 function appeared in
 251 .Bx 4.2 .
 252 The
 253 .Fn sendmmsg
 254 function appeared in
 255 .Fx 11.0 .
 256 .Sh BUGS
 257 Because
 258 .Fn sendmsg
 259 does not necessarily block until the data has been transferred, it
 260 is possible to transfer an open file descriptor across an
 261 .Dv AF_UNIX
 262 domain socket
 263 (see
 264 .Xr recv 2 ) ,
 265 then
 266 .Fn close
 267 it before it has actually been sent, the result being that the receiver
 268 gets a closed file descriptor.
 269 It is left to the application to
 270 implement an acknowledgment mechanism to prevent this from happening.