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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     From: @(#)send.2        8.2 (Berkeley) 2/21/94
  33 .\" $FreeBSD: src/lib/libc/sys/send.2,v 1.10.2.6 2001/12/14 18:34:01 ru Exp $
  34 .\"
  35 .Dd October 6, 2010
  36 .Dt SEND 2
  37 .Os
  38 .Sh NAME
  39 .Nm send ,
  40 .Nm sendto ,
  41 .Nm sendmsg
  42 .Nd send a message from a socket
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In sys/types.h
  47 .In sys/socket.h
  48 .Ft ssize_t
  49 .Fn send "int s" "const void *msgbuf" "size_t len" "int flags"
  50 .Ft ssize_t
  51 .Fn sendto "int s" "const void *msgbuf" "size_t len" "int flags" "const struct sockaddr *to" "socklen_t tolen"
  52 .Ft ssize_t
  53 .Fn sendmsg "int s" "const struct msghdr *msg" "int flags"
  54 .Sh DESCRIPTION
  55 .Fn Send ,
  56 .Fn sendto ,
  57 and
  58 .Fn sendmsg
  59 are used to transmit a message to another socket.
  60 .Fn Send
  61 may be used only when the socket is in a
  62 .Em connected
  63 state, while
  64 .Fn sendto
  65 and
  66 .Fn sendmsg
  67 may be used at any time.
  68 .Pp
  69 The socket file descriptor is given by
  70 .Fa s .
  71 .Fa msgbuf
  72 points to a buffer containing the message.
  73 .Fa msg
  74 points to a
  75 .Fa msghdr
  76 structure.
  77 The address of the target is given by
  78 .Fa to
  79 with
  80 .Fa tolen
  81 specifying its size.
  82 The length of the message is given by
  83 .Fa len .
  84 If the message is too long to pass atomically through the
  85 underlying protocol, the error
  86 .Er EMSGSIZE
  87 is returned, and
  88 the message is not transmitted.
  89 .Pp
  90 No indication of failure to deliver is implicit in a
  91 .Fn send .
  92 Locally detected errors are indicated by a return value of -1.
  93 .Pp
  94 If no messages space is available at the socket to hold
  95 the message to be transmitted, then
  96 .Fn send
  97 normally blocks, unless the socket has been placed in
  98 non-blocking I/O mode.
  99 The
 100 .Xr select 2
 101 call may be used to determine when it is possible to
 102 send more data.
 103 .Pp
 104 The
 105 .Fa flags
 106 parameter may include one or more of the following:
 107 .Bd -literal
 108 #define MSG_OOB         0x1   /* process out-of-band data */
 109 #define MSG_PEEK        0x2   /* peek at incoming message */
 110 #define MSG_DONTROUTE   0x4   /* bypass routing, use direct interface */
 111 #define MSG_EOR         0x8   /* data completes record */
 112 #define MSG_EOF         0x100 /* data completes transaction */
 113 #define MSG_NOSIGNAL    0x400 /* No SIGPIPE to unconnected socket stream */
 114 .Ed
 115 .Pp
 116 The flag
 117 .Dv MSG_OOB
 118 is used to send
 119 .Dq out-of-band
 120 data on sockets that support this notion (e.g.\&
 121 .Dv SOCK_STREAM ) ;
 122 the underlying protocol must also support
 123 .Dq out-of-band
 124 data.
 125 .Dv MSG_EOR
 126 is used to indicate a record mark for protocols which support the
 127 concept.
 128 .Dv MSG_EOF
 129 requests that the sender side of a socket be shut down, and that an
 130 appropriate indication be sent at the end of the specified data;
 131 this flag is only implemented for
 132 .Dv SOCK_STREAM
 133 sockets in the
 134 .Dv PF_INET
 135 protocol family.
 136 .Dv MSG_DONTROUTE
 137 is usually used only by diagnostic or routing programs.
 138 .Dv MSG_NOSIGNAL
 139 requests not to send the
 140 .Dv SIGPIPE
 141 signal if an attempt to
 142 .Nm
 143 is made on a stream-oriented socket that is no longer connected.
 144 .Pp
 145 See
 146 .Xr recv 2
 147 for a description of the
 148 .Fa msghdr
 149 structure.
 150 .Sh RETURN VALUES
 151 Upon successful completion the number of characters which were sent is
 152 returned.  Otherwise -1 is returned and the global variable
 153 .Va errno
 154 is set to indicate the error.
 155 .Sh ERRORS
 156 .Fn Send ,
 157 .Fn sendto ,
 158 and
 159 .Fn sendmsg
 160 fail if:
 161 .Bl -tag -width Er
 162 .It Bq Er EBADF
 163 An invalid descriptor was specified.
 164 .It Bq Er EACCES
 165 The destination address is a broadcast address, and
 166 .Dv SO_BROADCAST
 167 has not been set on the socket.
 168 .It Bq Er ENOTSOCK
 169 The argument
 170 .Fa s
 171 is not a socket.
 172 .It Bq Er EFAULT
 173 An invalid user space address was specified for a parameter.
 174 .It Bq Er EMSGSIZE
 175 The socket requires that message be sent atomically,
 176 and the size of the message to be sent made this impossible.
 177 .It Bq Er EAGAIN
 178 The socket is marked non-blocking and the requested operation
 179 would block.
 180 .It Bq Er ENOBUFS
 181 The system was unable to allocate an internal buffer.
 182 The operation may succeed when buffers become available.
 183 .It Bq Er ENOBUFS
 184 The output queue for a network interface was full.
 185 This generally indicates that the interface has stopped sending,
 186 but may be caused by transient congestion.
 187 .It Bq Er EHOSTUNREACH
 188 The remote host was unreachable.
 189 .It Bq Er ECONNREFUSED
 190 The socket received an ICMP destination unreachable message
 191 from the last message sent.  This typically means that the
 192 receiver is not listening on the remote port.
 193 .It Bq Er EHOSTDOWN
 194 The remote host was down.
 195 .It Bq Er EPIPE
 196 The socket is unable to send anymore data (SS_CANTSENDMORE has
 197 been set on the socket). This typically means that the socket
 198 is not connected.
 199 .El
 200 .Sh SEE ALSO
 201 .Xr fcntl 2 ,
 202 .Xr getsockopt 2 ,
 203 .Xr recv 2 ,
 204 .Xr select 2 ,
 205 .Xr socket 2 ,
 206 .Xr write 2
 207 .Sh HISTORY
 208 The
 209 .Fn send
 210 function call appeared in
 211 .Bx 4.2 .
 212 .Sh BUGS
 213 Because
 214 .Fn sendmsg
 215 doesn't necessarily block until the data has been transferred, it
 216 is possible to transfer an open file descriptor across an
 217 .Dv AF_UNIX
 218 domain socket
 219 (see
 220 .Xr recv 2 ) ,
 221 then
 222 .Fn close
 223 it before it has actually been sent, the result being that the receiver
 224 gets a closed file descriptor.  It is left to the application to
 225 implement an acknowledgment mechanism to prevent this from happening.