Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.
The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.
In the following statement, the phrase ``this text'' refers to portions
of the system documentation.
Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.
This notice shall appear on any product containing this material.
The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]
Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
Copyright (c) 2018, Joyent, Inc.
cc [ flag... ] file... -lxnet [ library ... ] #include <sys/socket.h> ssize_t sendto(int socket, const void *message, size_t length, int flags, const struct sockaddr *dest_addr, socklen_t dest_len);
The sendto() function sends a message through a connection-mode or connectionless-mode socket. If the socket is connectionless-mode, the message will be sent to the address specified by dest_addr. If the socket is connection-mode, dest_addr is ignored.
If the socket protocol supports broadcast and the specified address is a broadcast address for the socket protocol, sendto() will fail if the SO_BROADCAST option is not set for the socket.
The dest_addr argument specifies the address of the target. The length argument specifies the length of the message.
Successful completion of a call to sendto() does not guarantee delivery of the message. A return value of -1 indicates only locally-detected errors.
If space is not available at the sending socket to hold the message to be transmitted and the socket file descriptor does not have O_NONBLOCK set, sendto() blocks until space is available. If space is not available at the sending socket to hold the message to be transmitted and the socket file descriptor does have O_NONBLOCK set, sendto() will fail.
The socket in use may require the process to have appropriate privileges to use the sendto() function.
The function takes the following arguments: socket
Specifies the socket file descriptor.
Points to a buffer containing the message to be sent.
Specifies the size of the message in bytes.
Specifies the type of message transmission. Values of this argument are formed by logically OR'ing zero or more of the following flags: MSG_EOR
Terminates a record (if supported by the protocol)
Sends out-of-band data on sockets that support out-of-band data. The significance and semantics of out-of-band data are protocol-specific.
Don't generate the SIGPIPE signal when a stream-oriented socket is no longer connected.
Points to a sockaddr structure containing the destination address. The length and format of the address depend on the address family of the socket.
Specifies the length of the sockaddr structure pointed to by the dest_addr argument.
The select(3C) and poll(2) functions can be used to determine when it is possible to send more data.
Upon successful completion, sendto() returns the number of bytes sent. Otherwise, -1 is returned and errno is set to indicate the error.
In addition to the errors documented below, an asynchronous error generated by the underlying socket protocol may be returned. For the full list of errors, please see the corresponding socket protocol manual page. For example, for a list of TCP errors, please see tcp(7P).
The sendto() function will fail if: EAFNOSUPPORT
Addresses in the specified address family cannot be used with this socket.
EWOULDBLOCK
The socket's file descriptor is marked O_NONBLOCK and the requested operation would block.
The socket argument is not a valid file descriptor.
A connection was forcibly closed by a peer.
The message or destaddr parameter cannot be accessed.
A signal interrupted sendto() before any data was transmitted.
The message is too large to be sent all at once, as the socket requires.
The socket is connection-mode but is not connected.
The socket argument does not refer to a socket.
The socket argument is associated with a socket that does not support one or more of the values set in flags.
The socket is shut down for writing, or the socket is connection-mode and is no longer connected. In the latter case, and if the socket is of type SOCK_STREAM, the SIGPIPE signal is generated to the calling thread unless the MSG_NOSIGNAL flag is set.
If the address family of the socket is AF_UNIX, then sendto() will fail if: EIO
An I/O error occurred while reading from or writing to the file system.
Too many symbolic links were encountered in translating the pathname in the socket address.
A component of a pathname exceeded NAME_MAX characters, or an entire pathname exceeded PATH_MAX characters.
A component of the pathname does not name an existing file or the pathname is an empty string.
A component of the path prefix of the pathname in the socket address is not a directory.
The sendto() function may fail if: EACCES
Search permission is denied for a component of the path prefix; or write access to the named socket is denied.
The socket is not connection-mode and does not have its peer address set, and no destination address was specified.
The destination host cannot be reached (probably because the host is down or a remote router cannot reach it).
The dest_len argument is not a valid length for the address family.
An I/O error occurred while reading from or writing to the file system.
A destination address was specified and the socket is already connected.
The local interface used to reach the destination is down.
No route to the network is present.
Insufficient resources were available in the system to perform the operation.
Insufficient memory was available to fulfill the request.
There were insufficient STREAMS resources available for the operation to complete.
If the address family of the socket is AF_UNIX, then sendto() may fail if: ENAMETOOLONG
Pathname resolution of a symbolic link produced an intermediate result whose length exceeds PATH_MAX.
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| Interface Stability Standard |
| MT-Level MT-Safe |
poll(2), sockaddr(3SOCKET), getsockopt(3XNET), recv(3XNET), recvfrom(3XNET), recvmsg(3XNET), select(3C), send(3XNET), sendmsg(3XNET), setsockopt(3XNET), shutdown(3XNET), socket(3XNET), attributes(5), standards(5), tcp(7P)