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 .\" $DragonFly: src/lib/libc/sys/send.2,v 1.4 2004/08/27 21:23:32 asmodai Exp $
  35 .\"
  36 .Dd February 15, 1995
  37 .Dt SEND 2
  38 .Os
  39 .Sh NAME
  40 .Nm send ,
  41 .Nm sendto ,
  42 .Nm sendmsg
  43 .Nd send a message from a socket
  44 .Sh LIBRARY
  45 .Lb libc
  46 .Sh SYNOPSIS
  47 .In sys/types.h
  48 .In sys/socket.h
  49 .Ft ssize_t
  50 .Fn send "int s" "const void *msg" "size_t len" "int flags"
  51 .Ft ssize_t
  52 .Fn sendto "int s" "const void *msg" "size_t len" "int flags" "const struct sockaddr *to" "socklen_t tolen"
  53 .Ft ssize_t
  54 .Fn sendmsg "int s" "const struct msghdr *msg" "int flags"
  55 .Sh DESCRIPTION
  56 .Fn Send ,
  57 .Fn sendto ,
  58 and
  59 .Fn sendmsg
  60 are used to transmit a message to another socket.
  61 .Fn Send
  62 may be used only when the socket is in a
  63 .Em connected
  64 state, while
  65 .Fn sendto
  66 and
  67 .Fn sendmsg
  68 may be used at any time.
  69 .Pp
  70 The socket file descriptor is given by
  71 .Fa s .
  72 For
  73 .Fn send
  74 and
  75 .Fn sendto
  76 .Fa msg
  77 points to a buffer containing the message.
  78 For
  79 .Fn sendmsg
  80 .Fa msg
  81 points to a msghdr structure.
  82 The address of the target is given by
  83 .Fa to
  84 with
  85 .Fa tolen
  86 specifying its size.
  87 The length of the message is given by
  88 .Fa len .
  89 If the message is too long to pass atomically through the
  90 underlying protocol, the error
  91 .Er EMSGSIZE
  92 is returned, and
  93 the message is not transmitted.
  94 .Pp
  95 No indication of failure to deliver is implicit in a
  96 .Fn send .
  97 Locally detected errors are indicated by a return value of -1.
  98 .Pp
  99 If no messages space is available at the socket to hold
 100 the message to be transmitted, then
 101 .Fn send
 102 normally blocks, unless the socket has been placed in
 103 non-blocking I/O mode.
 104 The
 105 .Xr select 2
 106 call may be used to determine when it is possible to
 107 send more data.
 108 .Pp
 109 The
 110 .Fa flags
 111 parameter may include one or more of the following:
 112 .Bd -literal
 113 #define MSG_OOB         0x1   /* process out-of-band data */
 114 #define MSG_PEEK        0x2   /* peek at incoming message */
 115 #define MSG_DONTROUTE   0x4   /* bypass routing, use direct interface */
 116 #define MSG_EOR         0x8   /* data completes record */
 117 #define MSG_EOF         0x100 /* data completes transaction */
 118 .Ed
 119 .Pp
 120 The flag
 121 .Dv MSG_OOB
 122 is used to send
 123 .Dq out-of-band
 124 data on sockets that support this notion (e.g.\&
 125 .Dv SOCK_STREAM ) ;
 126 the underlying protocol must also support
 127 .Dq out-of-band
 128 data.
 129 .Dv MSG_EOR
 130 is used to indicate a record mark for protocols which support the
 131 concept.
 132 .Dv MSG_EOF
 133 requests that the sender side of a socket be shut down, and that an
 134 appropriate indication be sent at the end of the specified data;
 135 this flag is only implemented for
 136 .Dv SOCK_STREAM
 137 sockets in the
 138 .Dv PF_INET
 139 protocol family, and is used to implement Transaction
 140 .Tn TCP
 141 (see
 142 .Xr ttcp 4 ) .
 143 .Dv MSG_DONTROUTE
 144 is usually used only by diagnostic or routing programs.
 145 .Pp
 146 See
 147 .Xr recv 2
 148 for a description of the
 149 .Fa msghdr
 150 structure.
 151 .Sh RETURN VALUES
 152 The call returns the number of characters sent, or -1
 153 if an error occurred.
 154 .Sh ERRORS
 155 .Fn Send ,
 156 .Fn sendto ,
 157 and
 158 .Fn sendmsg
 159 fail if:
 160 .Bl -tag -width Er
 161 .It Bq Er EBADF
 162 An invalid descriptor was specified.
 163 .It Bq Er EACCES
 164 The destination address is a broadcast address, and
 165 .Dv SO_BROADCAST
 166 has not been set on the socket.
 167 .It Bq Er ENOTSOCK
 168 The argument
 169 .Fa s
 170 is not a socket.
 171 .It Bq Er EFAULT
 172 An invalid user space address was specified for a parameter.
 173 .It Bq Er EMSGSIZE
 174 The socket requires that message be sent atomically,
 175 and the size of the message to be sent made this impossible.
 176 .It Bq Er EAGAIN
 177 The socket is marked non-blocking and the requested operation
 178 would block.
 179 .It Bq Er ENOBUFS
 180 The system was unable to allocate an internal buffer.
 181 The operation may succeed when buffers become available.
 182 .It Bq Er ENOBUFS
 183 The output queue for a network interface was full.
 184 This generally indicates that the interface has stopped sending,
 185 but may be caused by transient congestion.
 186 .It Bq Er EHOSTUNREACH
 187 The remote host was unreachable.
 188 .It Bq Er ECONNREFUSED
 189 The socket received an ICMP destination unreachable message
 190 from the last message sent.  This typically means that the
 191 receiver is not listening on the remote port.
 192 .It Bq Er EHOSTDOWN
 193 The remote host was down.
 194 .It Bq Er EPIPE
 195 The socket is unable to send anymore data (SS_CANTSENDMORE has
 196 been set on the socket). This typically means that the socket
 197 is not connected.
 198 .El
 199 .Sh BUGS
 200 Because
 201 .Fn sendmsg
 202 doesn't necessarily block until the data has been transferred, it
 203 is possible to transfer an open file descriptor across an
 204 .Dv AF_UNIX
 205 domain socket
 206 (see
 207 .Xr recv 2 ) ,
 208 then
 209 .Fn close
 210 it before it has actually been sent, the result being that the receiver
 211 gets a closed file descriptor.  It is left to the application to
 212 implement an acknowlegment mechanism to prevent this from happening.
 213 .Sh SEE ALSO
 214 .Xr fcntl 2 ,
 215 .Xr getsockopt 2 ,
 216 .Xr recv 2 ,
 217 .Xr select 2 ,
 218 .Xr socket 2 ,
 219 .Xr write 2
 220 .Sh HISTORY
 221 The
 222 .Fn send
 223 function call appeared in
 224 .Bx 4.2 .