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