sendmmsg (2)

Leading comments

 Copyright (c) 1983, 1991, 1993
	The Regents of the University of California.  All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the fol...

(The comments found at the beginning of the groff file "man2/sendmmsg.2freebsd".)

NAME

send sendto sendmsg sendmmsg - send message(s) from a socket

LIBRARY

Lb libc

SYNOPSIS

In sys/types.h In sys/socket.h Ft ssize_t Fn send int s const void *msg size_t len int flags Ft ssize_t Fn sendto int s const void *msg size_t len int flags const struct sockaddr *to socklen_t tolen Ft ssize_t Fn sendmsg int s const struct msghdr *msg int flags Ft ssize_t Fn sendmmsg int s struct mmsghdr * restrict msgvec size_t vlen int flags

DESCRIPTION

The Fn send and Fn sendmmsg functions, and Fn sendto and Fn sendmsg system calls are used to transmit one or more messages (with the Fn sendmmsg call) to another socket. The Fn send function may be used only when the socket is in a connected state, while Fn sendto , Fn sendmsg and Fn sendmmsg may be used at any time.

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

The Fn sendmmsg function sends multiple messages at a call. They are given by the Fa msgvec vector along with Fa vlen specifying the vector size. The number of octets sent per each message is placed in the Fa msg_len field of each processed element of the vector after transmission.

No indication of failure to deliver is implicit in a Fn send . Locally detected errors are indicated by a return value of -1.

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

The Fa flags argument may include one or more of the following:

#define MSG_OOB         0x00001 /* process out-of-band data */
#define MSG_DONTROUTE   0x00004 /* bypass routing, use direct interface */
#define MSG_EOR         0x00008 /* data completes record */
#define MSG_EOF         0x00100 /* data completes transaction */
#define MSG_NOSIGNAL    0x20000 /* do not generate SIGPIPE on EOF */

The flag MSG_OOB is used to send ``out-of-band'' data on sockets that support this notion (e.g. SOCK_STREAM ) the underlying protocol must also support ``out-of-band'' data. MSG_EOR is used to indicate a record mark for protocols which support the concept. MSG_EOF requests that the sender side of a socket be shut down, and that an appropriate indication be sent at the end of the specified data; this flag is only implemented for SOCK_STREAM sockets in the PF_INET protocol family. MSG_DONTROUTE is usually used only by diagnostic or routing programs. MSG_NOSIGNAL is used to prevent SIGPIPE generation when writing a socket that may be closed.

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

RETURN VALUES

The Fn send , Fn sendto and Fn sendmsg calls return the number of octets sent. The Fn sendmmsg call returns the number of messages sent. If an error occurred a value of -1 is returned.

ERRORS

The Fn send and Fn sendmmsg functions and Fn sendto and Fn sendmsg system calls fail if:

Bq Er EBADF

An invalid descriptor was specified.

Bq Er EACCES

The destination address is a broadcast address, and SO_BROADCAST has not been set on the socket.

Bq Er ENOTSOCK

The argument Fa s is not a socket.

Bq Er EFAULT

An invalid user space address was specified for an argument.

Bq Er EMSGSIZE

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

Bq Er EAGAIN

The socket is marked non-blocking and the requested operation would block.

Bq Er ENOBUFS

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

Bq Er 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.

Bq Er EHOSTUNREACH

The remote host was unreachable.

Bq Er EISCONN

A destination address was specified and the socket is already connected.

Bq Er ECONNREFUSED

The socket received an ICMP destination unreachable message from the last message sent. This typically means that the receiver is not listening on the remote port.

Bq Er EHOSTDOWN

The remote host was down.

Bq Er ENETDOWN

The remote network was down.

Bq Er EADDRNOTAVAIL

The process using a SOCK_RAW socket was jailed and the source address specified in the IP header did not match the IP address bound to the prison.

Bq Er EPIPE

The socket is unable to send anymore data ( SBS_CANTSENDMORE has been set on the socket). This typically means that the socket is not connected.

SEE ALSO

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

HISTORY

The Fn send function appeared in BSD 4.2 The Fn sendmmsg function appeared in Fx 11.0 .

BUGS

Because Fn sendmsg does not necessarily block until the data has been transferred, it is possible to transfer an open file descriptor across an AF_UNIX domain socket (see recv(2)), then Fn close it before it has actually been sent, the result being that the receiver gets a closed file descriptor. It is left to the application to implement an acknowledgment mechanism to prevent this from happening.