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 sendmsg(int socket, const struct msghdr *message, int flags);
The function takes the following arguments: socket
Specifies the socket file descriptor.
Points to a msghdr structure, containing both the destination address and the buffers for the outgoing message. The length and format of the address depend on the address family of the socket. The msg_flags member is ignored.
Specifies the type of message transmission. The application may specify 0 or the following flag: MSG_EOR
Terminates a record (if supported by the protocol)
Sends out-of-band data on sockets that support out-of-bound 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.
The sendmsg() 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 msghdr. If the socket is connection-mode, the destination address in msghdr is ignored.
The msg_iov and msg_iovlen fields of message specify zero or more buffers containing the data to be sent. msg_iov points to an array of iovec structures; msg_iovlen must be set to the dimension of this array. In each iovec structure, the iov_base field specifies a storage area and the iov_len field gives its size in bytes. Some of these sizes can be zero. The data from each storage area indicated by msg_iov is sent in turn.
Successful completion of a call to sendmsg() 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, sendmsg() function 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, sendmsg() function will fail.
If the socket protocol supports broadcast and the specified address is a broadcast address for the socket protocol, sendmsg() will fail if the SO_BROADCAST option is not set for the socket.
The socket in use may require the process to have appropriate privileges to use the sendmsg() function.
The select(3C) and poll(2) functions can be used to determine when it is possible to send more data.
Upon successful completion, sendmsg() function 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 sendmsg() function will fail if: EAGAIN
EWOULDBLOCK
The socket's file descriptor is marked O_NONBLOCK and the requested operation would block.
Addresses in the specified address family cannot be used with this socket.
The socket argument is not a valid file descriptor.
A connection was forcibly closed by a peer.
The message parameter, or storage pointed to by the msg_name, msg_control or msg_iov fields of the message parameter, or storage pointed to by the iovec structures pointed to by the msg_iov field can not be accessed.
A signal interrupted sendmsg() before any data was transmitted.
The sum of the iov_len values overflows an ssize_t.
The message is to large to be sent all at once (as the socket requires), or the msg_iovlen member of the msghdr structure pointed to by message is less than or equal to 0 or is greater than IOV_MAX.
The socket is connection-mode but is not connected.
The socket argument does not refer 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 sendmsg() 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 sendmsg() 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).
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 sendmsg() 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) getsockopt(3XNET), recv(3XNET), recvfrom(3XNET), recvmsg(3XNET), select(3C), send(3XNET), sendto(3XNET), setsockopt(3XNET), shutdown(3XNET), socket(3XNET), attributes(5), standards(5), tcp(7P)