xref: /csrg-svn/lib/libc/sys/send.2 (revision 36759)
Copyright (c) 1983 The Regents of the University of California.
All rights reserved.

Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are
duplicated in all such forms and that any documentation,
advertising materials, and other materials related to such
distribution and use acknowledge that the software was developed
by the University of California, Berkeley. The name of the
University may not be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

@(#)send.2 6.5 (Berkeley) 02/14/89

SEND 2 ""
C 5
NAME
send, sendto, sendmsg - send a message from a socket
SYNOPSIS
#include <sys/types.h>
#include <sys/socket.h>

cc = send(s, msg, len, flags) int cc, s; char *msg; int len, flags;

cc = sendto(s, msg, len, flags, to, tolen) int cc, s; char *msg; int len, flags; struct sockaddr *to; int tolen;

cc = sendmsg(s, msg, flags) int cc, s; struct msghdr *msg; int flags;

DESCRIPTION
Send , sendto , and sendmsg are used to transmit a message to another socket. Send may be used only when the socket is in a connected state, while sendto and sendmsg may be used at any time.

The address of the target is given by to with tolen specifying its size. The length of the message is given by len . If the message is too long to pass atomically through the underlying protocol, then the error EMSGSIZE is returned, and the message is not transmitted.

No indication of failure to deliver is implicit in a send . Return values of -1 indicate some locally detected errors.

If no messages space is available at the socket to hold the message to be transmitted, then send normally blocks, unless the socket has been placed in non-blocking I/O mode. The select (2) call may be used to determine when it is possible to send more data.

The flags parameter may include one or more of the following:

#define MSG_OOB 0x1 /* process out-of-band data */ #define MSG_DONTROUTE 0x4 /* bypass routing, use direct interface */

The flag MSG_OOB is used to send \*(lqout-of-band\*(rq data on sockets that support this notion (e.g. SOCK_STREAM); the underlying protocol must also support \*(lqout-of-band\*(rq data. MSG_DONTROUTE is usually used only by diagnostic or routing programs.

See recv (2) for a description of the msghdr structure.

"RETURN VALUE
The call returns the number of characters sent, or -1 if an error occurred.
"ERRORS

20 [EBADF] An invalid descriptor was specified.

20 [ENOTSOCK] The argument s is not a socket.

20 [EFAULT] An invalid user space address was specified for a parameter.

20 [EMSGSIZE] The socket requires that message be sent atomically, and the size of the message to be sent made this impossible.

20 [EWOULDBLOCK] The socket is marked non-blocking and the requested operation would block.

20 [ENOBUFS] The system was unable to allocate an internal buffer. The operation may succeed when buffers become available.

20 [ENOBUFS] The output queue for a network interface was full. This generally indicates that the interface has stopped sending, but may be caused by transient congestion.

SEE ALSO
fcntl(2), recv(2), select(2), getsockopt(2), socket(2), write(2)