Penguin
Recent Changes
Annotated edit history of sendmsg(2) version 3, including all changes. View license author blame.
Rev Author # Line
1 perry 1 !!NAME
2 PerryLorier 2 send, sendto, sendmsg - send a message from a socket
1 perry 3
4 !!SYNOPSIS
2 PerryLorier 5 __#include <sys/types.h>__
6 __#include <sys/socket.h>__
1 perry 7
3 PerryLorier 8 __int sendmsg(int__ ''s''__, const struct msghdr *__''msg''__, int__ ''flags''__);__
1 perry 9
10 !!DESCRIPTION
2 PerryLorier 11 sendmsg(2) is used to transmit a message to another socket. sendmsg(2) may be used at any time, the socket does not have to be connected.
1 perry 12
2 PerryLorier 13 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, the error [EMSGSIZE] is returned, and the message is not transmitted.
1 perry 14
2 PerryLorier 15 No indication of failure to deliver is implicit in a sendmsg(2). Locally detected errors are indicated by a return value of -1.
1 perry 16
2 PerryLorier 17 When the message does not fit into the send buffer of the socket, sendmsg(2) normally blocks, unless the socket has been placed in non-blocking I/O mode. In non-blocking mode
18 it would return [EAGAIN] in this case. The select(2) call may be used to determine when it is possible to send more data.
1 perry 19
2 PerryLorier 20 The ''flags'' parameter is a flagword and can contain the following flags:
1 perry 21
2 PerryLorier 22 ;[MSG_OOB]: Sends ''out-of-band'' data on sockets that support this notion (e.g. __SOCK_STREAM__); the underlying protocol must also support ''out-of-band'' data.
1 perry 23
2 PerryLorier 24 ;[MSG_DONTROUTE]: Dont't use a gateway to send out the packet, only send to hosts on directly connected networks. This is usually used only by diagnostic or routing programs. This is only defined for protocol families that route; packet sockets don't.
1 perry 25
2 PerryLorier 26 ;[MSG_DONTWAIT]: Enables non-blocking operation; if the operation would block, [EAGAIN] is returned (this can also be enabled using the __O_NONBLOCK__ with the __F_SETFL fcntl(2)).__
1 perry 27
2 PerryLorier 28 ;[MSG_NOSIGNAL]: Requests not to send [SIGPIPE] on errors on stream oriented sockets when the other end breaks the connection. The __EPIPE__ error is still returned.
1 perry 29
2 PerryLorier 30 ;[MSG_CONFIRM](Linux 2.3+ only): Tell the link layer that forward process happened: you got a successful reply from the other side. If the link layer doesn't get this it'll regularly reprobe the neighbour (e.g. via a unicast ARP). Only valid on __SOCK_DGRAM__ and __SOCK_RAW__ sockets and currently only implemented for IPv4 and IPv6. See arp(7) for details.
1 perry 31
2 PerryLorier 32 The definition of the ''msghdr'' structure follows. See recv(2) and below for an exact description of its fields.
1 perry 33
2 PerryLorier 34 struct msghdr {
35 void * msg_name; /* optional address */
36 socklen_t msg_namelen; /* size of address */
37 struct iovec * msg_iov; /* scatter/gather array */
38 size_t msg_iovlen; /* # elements in msg_iov */
39 void * msg_control; /* ancillary data, see below */
40 socklen_t msg_controllen; /* ancillary data buffer len */
41 int msg_flags; /* flags on received message */
42 };
1 perry 43
2 PerryLorier 44 You may send control information using the ''msg_control'' and ''msg_controllen'' members. The maximum control buffer length the kernel can process is limited per socket by the __net.core.optmem_max__ sysctl; see socket(7).
1 perry 45
46 !!RETURN VALUE
47
2 PerryLorier 48 The calls return the number of characters sent, or -1 if an error occurred.
1 perry 49 !!ERRORS
2 PerryLorier 50 These are some standard errors generated by the socket layer. Additional errors may be generated and returned from the underlying protocol modules; see their respective manual pages.
1 perry 51
2 PerryLorier 52 ;[EBADF]: An invalid descriptor was specified.
53 ;[ENOTSOCK]: The argument ''s'' is not a socket.
54 ;[EFAULT]: An invalid user space address was specified for a parameter.
55 ;[EMSGSIZE]: The socket requires that message be sent atomically, and the size of the message to be sent made this impossible.
56 ;[EAGAIN] or __EWOULDBLOCK__: The socket is marked non-blocking and the requested operation would block.
57 ;[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. (This cannot
58 occur in Linux, packets are just silently dropped when a device queue overflows.)
59 ;[EINTR]: A signal occurred.
60 ;[ENOMEM]: No memory available.
61 ;[EINVAL]: Invalid argument passed.
62 ;[EPIPE]: The local end has been shut down on a connection oriented socket. In this case the process will also receive a [SIGPIPE] unless __MSG_NOSIGNAL__ is set.
1 perry 63 !!CONFORMING TO
2 PerryLorier 64 4.4BSD, SVr4, POSIX 1003.1g draft (these function calls appeared in 4.2BSD).
1 perry 65
66 __MSG_CONFIRM__ is a Linux extension.
67 !!NOTE
2 PerryLorier 68 The prototypes given above follow the Single Unix Specification, as glibc2 also does; the ''flags'' argument was `int' in BSD 4.*, but `unsigned int' in libc4 and libc5; the ''len'' argument was `int' in BSD 4.* and libc4, but `size_t' in libc5; the ''tolen'' argument was `int' in BSD 4.* and libc4 and libc5. See also accept(2).
1 perry 69 !!SEE ALSO
2 PerryLorier 70 fcntl(2), recv(2), select(2), getsockopt(2), sendfile(2), socket(2), write(2), socket(7), ip(7), tcp(7), udp(7), send(2), sendto(2)
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.

PHP Warning

lib/blame.php:177: Warning: Invalid argument supplied for foreach() (...repeated 4 times)