ca860369996dfc34cfed9802731f1d91b34a258f
[dragonfly.git] / 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.7 2006/02/17 19:35:06 swildner 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 *msgbuf" "size_t len" "int flags"
51 .Ft ssize_t
52 .Fn sendto "int s" "const void *msgbuf" "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 .Fa msgbuf
73 points to a buffer containing the message.
74 .Fa msg
75 points to a
76 .Fa msghdr
77 structure.
78 The address of the target is given by
79 .Fa to
80 with
81 .Fa tolen
82 specifying its size.
83 The length of the message is given by
84 .Fa len .
85 If the message is too long to pass atomically through the
86 underlying protocol, the error
87 .Er EMSGSIZE
88 is returned, and
89 the message is not transmitted.
90 .Pp
91 No indication of failure to deliver is implicit in a
92 .Fn send .
93 Locally detected errors are indicated by a return value of -1.
94 .Pp
95 If no messages space is available at the socket to hold
96 the message to be transmitted, then
97 .Fn send
98 normally blocks, unless the socket has been placed in
99 non-blocking I/O mode.
100 The
101 .Xr select 2
102 call may be used to determine when it is possible to
103 send more data.
104 .Pp
105 The
106 .Fa flags
107 parameter may include one or more of the following:
108 .Bd -literal
109 #define MSG_OOB         0x1   /* process out-of-band data */
110 #define MSG_PEEK        0x2   /* peek at incoming message */
111 #define MSG_DONTROUTE   0x4   /* bypass routing, use direct interface */
112 #define MSG_EOR         0x8   /* data completes record */
113 #define MSG_EOF         0x100 /* data completes transaction */
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, and is used to implement Transaction
136 .Tn TCP
137 (see
138 .Xr ttcp 4 ) .
139 .Dv MSG_DONTROUTE
140 is usually used only by diagnostic or routing programs.
141 .Pp
142 See
143 .Xr recv 2
144 for a description of the
145 .Fa msghdr
146 structure.
147 .Sh RETURN VALUES
148 Upon successful completion the number of characters which were sent is
149 returned.  Otherwise -1 is returned and the global variable errno is
150 set to indicate the error.
151 .Sh ERRORS
152 .Fn Send ,
153 .Fn sendto ,
154 and
155 .Fn sendmsg
156 fail if:
157 .Bl -tag -width Er
158 .It Bq Er EBADF
159 An invalid descriptor was specified.
160 .It Bq Er EACCES
161 The destination address is a broadcast address, and
162 .Dv SO_BROADCAST
163 has not been set on the socket.
164 .It Bq Er ENOTSOCK
165 The argument
166 .Fa s
167 is not a socket.
168 .It Bq Er EFAULT
169 An invalid user space address was specified for a parameter.
170 .It Bq Er EMSGSIZE
171 The socket requires that message be sent atomically,
172 and the size of the message to be sent made this impossible.
173 .It Bq Er EAGAIN
174 The socket is marked non-blocking and the requested operation
175 would block.
176 .It Bq Er ENOBUFS
177 The system was unable to allocate an internal buffer.
178 The operation may succeed when buffers become available.
179 .It Bq Er ENOBUFS
180 The output queue for a network interface was full.
181 This generally indicates that the interface has stopped sending,
182 but may be caused by transient congestion.
183 .It Bq Er EHOSTUNREACH
184 The remote host was unreachable.
185 .It Bq Er ECONNREFUSED
186 The socket received an ICMP destination unreachable message
187 from the last message sent.  This typically means that the
188 receiver is not listening on the remote port.
189 .It Bq Er EHOSTDOWN
190 The remote host was down.
191 .It Bq Er EPIPE
192 The socket is unable to send anymore data (SS_CANTSENDMORE has
193 been set on the socket). This typically means that the socket
194 is not connected.
195 .El
196 .Sh SEE ALSO
197 .Xr fcntl 2 ,
198 .Xr getsockopt 2 ,
199 .Xr recv 2 ,
200 .Xr select 2 ,
201 .Xr socket 2 ,
202 .Xr write 2
203 .Sh HISTORY
204 The
205 .Fn send
206 function call appeared in
207 .Bx 4.2 .
208 .Sh BUGS
209 Because
210 .Fn sendmsg
211 doesn't necessarily block until the data has been transferred, it
212 is possible to transfer an open file descriptor across an
213 .Dv AF_UNIX
214 domain socket
215 (see
216 .Xr recv 2 ) ,
217 then
218 .Fn close
219 it before it has actually been sent, the result being that the receiver
220 gets a closed file descriptor.  It is left to the application to
221 implement an acknowlegment mechanism to prevent this from happening.