Index: stable/7/lib/libc/net/sctp_opt_info.3 =================================================================== --- stable/7/lib/libc/net/sctp_opt_info.3 (revision 204290) +++ stable/7/lib/libc/net/sctp_opt_info.3 (revision 204291) @@ -1,115 +1,117 @@ .\" 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 following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. All advertising materials mentioning features or use of this software .\" must display the following acknowledgement: .\" This product includes software developed by the University of .\" California, Berkeley and its contributors. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" From: @(#)send.2 8.2 (Berkeley) 2/21/94 .\" $FreeBSD$ .\" .Dd December 15, 2006 .Dt SCTP_OPT_INFO 3 .Os .Sh NAME .Nm sctp_opt_info .Nd get SCTP socket information .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In sys/types.h .In sys/socket.h .In netinet/sctp.h .Ft int .Fn sctp_opt_info "int sd" "sctp_assoc_t id" "int opt" "void *arg" "socklen_t *size" .Sh DESCRIPTION The .Fn sctp_opt_info call provides a multi-os compatible method for getting specific .Fn getsockopt data where an association identification needs to be passed into the operating system. For .Fx a direct .Fn getsockopt may be used, since .Fx has the ability to pass information into the operating system on a .Fn getsockopt call. Other operating systems may not have this ability. For those who wish to write portable code amongst multiple operating systems this call should be used for the following SCTP socket options. .Pp .Dv SCTP_RTOINFO .Pp .Dv SCTP_ASSOCINFO .Pp .Dv SCTP_PRIMARY_ADDR .Pp .Dv SCTP_SET_PEER_PRIMARY_ADDR .Pp .Dv SCTP_STATUS .Pp .Dv SCTP_GET_PEER_ADDR_INFO .Pp .Dv SCTP_AUTH_ACTIVE_KEY .Pp .Dv SCTP_PEER_AUTH_CHUNKS .Pp .Dv SCTP_LOCAL_AUTH_CHUNKS +.Sh RETURN VALUES +The call returns 0 on success and -1 upon error. .Sh ERRORS The .Fn sctp_opt_info function can return the following errors: .Bl -tag -width Er .It Bq Er EINVAL The argument .Fa arg value was invalid. .It Bq Er EOPNOTSUPP The argument .Fa opt was not one of the above listed SCTP socket options. .It Bq Er EBADF The argument .Fa s is not a valid descriptor. .It Bq Er ENOTSOCK The argument .Fa s is not a socket. .El .Sh SEE ALSO .Xr getsockopt 2 , .Xr sctp 4 Index: stable/7/lib/libc/net/sctp_recvmsg.3 =================================================================== --- stable/7/lib/libc/net/sctp_recvmsg.3 (revision 204290) +++ stable/7/lib/libc/net/sctp_recvmsg.3 (revision 204291) @@ -1,298 +1,298 @@ .\" 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 following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. All advertising materials mentioning features or use of this software .\" must display the following acknowledgement: .\" This product includes software developed by the University of .\" California, Berkeley and its contributors. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd August 13, 2007 .Dt SCTP_RECVMSG 3 .Os .Sh NAME .Nm sctp_recvmsg .Nd receive a message from an SCTP socket .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In sys/types.h .In sys/socket.h .In netinet/sctp.h .Ft ssize_t .Fo sctp_recvmsg .Fa "int s" "void *msg" "size_t len" "struct sockaddr * restrict from" .Fa "socklen_t * restrict fromlen" "struct sctp_sndrcvinfo *sinfo" "int *flags" .Fc .Sh DESCRIPTION The .Fn sctp_recvmsg system call is used to receive a message from another SCTP endpoint. The .Fn sctp_recvmsg call is used by one-to-one (SOCK_STREAM) type sockets after a successful .Fn connect call or after the application has performed a .Fn listen followed by a successful .Fn accept . For a one-to-many (SOCK_SEQPACKET) type socket, an endpoint may call .Fn sctp_recvmsg after having implicitly started an association via one of the send calls including .Fn sctp_sendmsg .Fn sendto and .Fn sendmsg . Or, an application may also receive a message after having called .Fn listen with a positive backlog to enable the reception of new associations. .Pp The address of the sender is held in the .Fa from argument with .Fa fromlen specifying its size. At the completion of a successful .Fn sctp_recvmsg call .Fa from will hold the address of the peer and .Fa fromlen will hold the length of that address. Note that the address is bounded by the inital value of .Fa fromlen which is used as an in/out variable. .Pp The length of the message .Fa msg to be received is bounded by .Fa len . If the message is too long to fit in the users receive buffer, then the .Fa flags argument will .Em not have the .Dv MSG_EOF flag applied. If the message is a complete message then the .Fa flags argument will have .Dv MSG_EOF set. Locally detected errors are indicated by a return value of -1 with .Va errno set accordingly. The .Fa flags argument may also hold the value .Dv MSG_NOTIFICATION . When this occurs it indicates that the message received is .Em not from the peer endpoint, but instead is a notification from the SCTP stack (see .Xr sctp 4 for more details). Note that no notifications are ever given unless the user subscribes to such notifications using the .Dv SCTP_EVENTS socket option. .Pp If no messages are available at the socket then .Fn sctp_recvmsg normally blocks on the reception of a message or NOTIFICATION, unless the socket has been placed in non-blocking I/O mode. The .Xr select 2 system call may be used to determine when it is possible to receive a message. .Pp The .Fa sinfo argument is defined as follows. .Bd -literal struct sctp_sndrcvinfo { u_int16_t sinfo_stream; /* Stream arriving on */ u_int16_t sinfo_ssn; /* Stream Sequence Number */ u_int16_t sinfo_flags; /* Flags on the incoming message */ u_int32_t sinfo_ppid; /* The ppid field */ u_int32_t sinfo_context; /* context field */ u_int32_t sinfo_timetolive; /* not used by sctp_recvmsg */ u_int32_t sinfo_tsn; /* The transport sequence number */ u_int32_t sinfo_cumtsn; /* The cumulative acknowledgment point */ sctp_assoc_t sinfo_assoc_id; /* The association id of the peer */ }; .Ed .Pp The .Fa sinfo->sinfo_ppid field is an opaque 32 bit value that is passed transparently through the stack from the peer endpoint. Note that the stack passes this value without regard to byte order. .Pp The .Fa sinfo->sinfo_flags field may include the following: .Bd -literal #define SCTP_UNORDERED 0x0400 /* Message is un-ordered */ .Ed .Pp The .Dv SCTP_UNORDERED flag is used to specify that the message arrived with no specific order and was delivered to the peer application as soon as possible. When this flag is absent the message was delivered in order within the stream it was received. .Pp The .Fa sinfo->sinfo_stream field is the SCTP stream that the message was received on. Streams in SCTP are reliable (or partially reliable) flows of ordered messages. .Pp The .Fa sinfo->sinfo_context field is used only if the local application set an association level context with the .Dv SCTP_CONTEXT socket option. Optionally a user process can use this value to index some application specific data structure for all data coming from a specific association. .Pp The .Fa sinfo->sinfo_ssn field will hold the stream sequence number assigned by the peer endpoint if the message is .Em not unordered. For unordered messages this field holds an undefined value. .Pp The .Fa sinfo->sinfo_tsn field holds a transport sequence number (TSN) that was assigned to this message by the peer endpoint. For messages that fit in or less than the path MTU this will be the only TSN assigned. Note that for messages that span multiple TSNs this value will be one of the TSNs that was used on the message. .Pp The .Fa sinfo->sinfo_cumtsn field holds the current cumulative acknowledgment point of the transport association. Note that this may be larger or smaller than the TSN assigned to the message itself. .Pp The .Fa sinfo->sinfo_assoc_id is the unique association identification that was assigned to the association. For one-to-many (SOCK_SEQPACKET) type sockets this value can be used to send data to the peer without the use of an address field. It is also quite useful in setting various socket options on the specific association (see .Xr sctp 4 ) . .Pp The .Fa sinfo->info_timetolive field is not used by .Fn sctp_recvmsg . .Sh RETURN VALUES The call returns the number of characters sent, or -1 if an error occurred. .Sh ERRORS The .Fn sctp_recvmsg system call fails if: .Bl -tag -width Er .It Bq Er EBADF An invalid descriptor was specified. .It Bq Er ENOTSOCK The argument .Fa s is not a socket. .It Bq Er EFAULT An invalid user space address was specified for an argument. .It Bq Er EMSGSIZE The socket requires that message be sent atomically, and the size of the message to be sent made this impossible. .It Bq Er EAGAIN The socket is marked non-blocking and the requested operation would block. .It Bq Er ENOBUFS The system was unable to allocate an internal buffer. The operation may succeed when buffers become available. .It 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. .It Bq Er EHOSTUNREACH The remote host was unreachable. -.It Bq Er ENOTCON +.It Bq Er ENOTCONN On a one-to-one style socket no association exists. .It Bq Er ECONNRESET An abort was received by the stack while the user was attempting to send data to the peer. .It Bq Er ENOENT On a one to many style socket no address is specified so that the association cannot be located or the SCTP_ABORT flag was specified on a non-existing association. .It Bq Er EPIPE The socket is unable to send anymore data .Dv ( SBS_CANTSENDMORE has been set on the socket). This typically means that the socket is not connected and is a one-to-one style socket. .El .Sh SEE ALSO .Xr recv 2 , .Xr select 2 , .Xr socket 2 , .Xr write 2 , .Xr getsockopt 2 , .Xr setsockopt 2 , .Xr sctp_send 3 , .Xr sctp_sendmsg 3 , .Xr sendmsg 3 , .Xr sctp 4 Index: stable/7/lib/libc/net/sctp_send.3 =================================================================== --- stable/7/lib/libc/net/sctp_send.3 (revision 204290) +++ stable/7/lib/libc/net/sctp_send.3 (revision 204291) @@ -1,354 +1,354 @@ .\" 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 following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. All advertising materials mentioning features or use of this software .\" must display the following acknowledgement: .\" This product includes software developed by the University of .\" California, Berkeley and its contributors. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd December 15, 2006 .Dt SCTP_SEND 3 .Os .Sh NAME .Nm sctp_send , .Nm sctp_sendx .Nd send a message from an SCTP socket .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In sys/types.h .In sys/socket.h .In netinet/sctp.h .Ft ssize_t .Fo sctp_send .Fa "int sd" "const void *msg" "size_t len" .Fa "const struct sctp_sndrcvinfo *sinfo" "int flags" .Fc .Ft ssize_t .Fo sctp_sendx .Fa "int sd" "const void *msg" "size_t len" "struct sockaddr *addrs" .Fa "int addrcnt" "const struct sctp_sndrcvinfo *sinfo" "int flags" .Fc .Sh DESCRIPTION The .Fn sctp_send system call is used to transmit a message to another SCTP endpoint. .Fn sctp_send may be used to send data to an existing association for both one-to-many (SOCK_SEQPACKET) and one-to-one (SOCK_STREAM) socket types. The length of the message .Fa msg is given by .Fa len . If the message is too long to pass atomically through the underlying protocol, .Va errno is set to .Er EMSGSIZE , -1 is returned, and the message is not transmitted. .Pp No indication of failure to deliver is implicit in a .Fn sctp_send . Locally detected errors are indicated by a return value of -1. .Pp If no space is available at the socket to hold the message to be transmitted, then .Fn sctp_send normally blocks, unless the socket has been placed in non-blocking I/O mode. The .Xr select 2 system call may be used to determine when it is possible to send more data on one-to-one type (SOCK_STREAM) sockets. .Pp The .Fa sinfo structure is used to control various SCTP features and has the following format: .Bd -literal struct sctp_sndrcvinfo { u_int16_t sinfo_stream; /* Stream sending to */ u_int16_t sinfo_ssn; /* valid for recv only */ u_int16_t sinfo_flags; /* flags to control sending */ u_int32_t sinfo_ppid; /* ppid field */ u_int32_t sinfo_context; /* context field */ u_int32_t sinfo_timetolive; /* timetolive for PR-SCTP */ u_int32_t sinfo_tsn; /* valid for recv only */ u_int32_t sinfo_cumtsn; /* valid for recv only */ sctp_assoc_t sinfo_assoc_id; /* The association id */ }; .Ed .Pp The .Fa sinfo->sinfo_ppid argument is an opaque 32 bit value that is passed transparently through the stack to the peer endpoint. It will be available on reception of a message (see .Xr sctp_recvmsg 2 ) . Note that the stack passes this value without regard to byte order. .Pp The .Fa sinfo->sinfo_flags argument may include one or more of the following: .Bd -literal #define SCTP_EOF 0x0100 /* Start a shutdown procedures */ #define SCTP_ABORT 0x0200 /* Send an ABORT to peer */ #define SCTP_UNORDERED 0x0400 /* Message is un-ordered */ #define SCTP_ADDR_OVER 0x0800 /* Override the primary-address */ #define SCTP_SENDALL 0x1000 /* Send this on all associations */ /* for the endpoint */ /* The lower byte is an enumeration of PR-SCTP policies */ #define SCTP_PR_SCTP_TTL 0x0001 /* Time based PR-SCTP */ #define SCTP_PR_SCTP_BUF 0x0002 /* Buffer based PR-SCTP */ #define SCTP_PR_SCTP_RTX 0x0003 /* Number of retransmissions based PR-SCTP */ .Ed .Pp The flag .Dv SCTP_EOF is used to instruct the SCTP stack to queue this message and then start a graceful shutdown of the association. All remaining data in queue will be sent after which the association will be shut down. .Pp .Dv SCTP_ABORT is used to immediately terminate an association. An abort is sent to the peer and the local TCB is destroyed. .Pp .Dv SCTP_UNORDERED is used to specify that the message being sent has no specific order and should be delivered to the peer application as soon as possible. When this flag is absent messages are delivered in order within the stream they are sent, but without respect to order to peer streams. .Pp The flag .Dv SCTP_ADDR_OVER is used to specify that a specific address should be used. Normally SCTP will use only one of a multi-homed peers addresses as the primary address to send to. By default, no matter what the .Fa to argument is, this primary address is used to send data. By specifying this flag, the user is asking the stack to ignore the primary address and instead use the specified address not only as a lookup mechanism to find the association but also as the actual address to send to. .Pp For a one-to-many type (SOCK_SEQPACKET) socket the flag .Dv SCTP_SENDALL can be used as a convenient way to make one send call and have all associations that are under the socket get a copy of the message. Note that this mechanism is quite efficent and makes only one actual copy of the data which is shared by all the associations for sending. .Pp The remaining flags are used for the partial reliability extension (RFC3758) and will only be effective if the peer endpoint supports this extension. This option specifies what local policy the local endpoint should use in skipping data. If none of these options are set, then data is never skipped over. .Pp .Dv SCTP_PR_SCTP_TTL is used to indicate that a time based lifetime is being applied to the data. The .Fa sinfo->sinfo_timetolive argument is then a number of milliseconds for which the data is attempted to be transmitted. If that many milliseconds ellapse and the peer has not acknowledged the data, the data will be skipped and no longer transmitted. Note that this policy does not even assure that the data will ever be sent. In times of a congestion with large amounts of data being queued, the .Fa sinfo->sinfo_timetolive may expire before the first transmission is ever made. .Pp The .Dv SCTP_PR_SCTP_BUF based policy transforms the .Fa sinfo->sinfo_timetolive field into a total number of bytes allowed on the outbound send queue. If that number or more bytes are in queue, then other buffer-based sends are looked to be removed and skipped. Note that this policy may also result in the data never being sent if no buffer based sends are in queue and the maximum specified by .Fa timetolive bytes is in queue. .Pp The .Dv SCTP_PR_SCTP_RTX policy transforms the .Fa sinfo->sinfo_timetolive into a number of retransmissions to allow. This policy always assures that at a minimum one send attempt is made of the data. After which no more than .Fa sinfo->sinfo_timetolive retransmissions will be made before the data is skipped. .Pp .Fa sinfo->sinfo_stream is the SCTP stream that you wish to send the message on. Streams in SCTP are reliable (or partially reliable) flows of ordered messages. .Pp The .Fa sinfo->sinfo_assoc_id field is used to select the association to send to on a one-to-many socket. For a one-to-one socket, this field is ignored. .Pp The .Fa sinfo->sinfo_context field is used only in the event the message cannot be sent. This is an opaque value that the stack retains and will give to the user when a failed send is given if that notification is enabled (see .Xr sctp 4 ) . Normally a user process can use this value to index some application specific data structure when a send cannot be fulfilled. .Pp The .Fa flags argument holds the same meaning and values as those found in .Xr sendmsg 2 but is generally ignored by SCTP. .Pp The fields .Fa sinfo->sinfo_ssn , .Fa sinfo->sinfo_tsn , and .Fa sinfo->sinfo_cumtsn are used only when receiving messages and are thus ignored by .Fn sctp_send . The function .Fn sctp_sendx has the same properties as .Fn sctp_send with the additional arguments of an array of sockaddr structures passed in. With the .Fa addrs argument being given as an array of addresses to be sent to and the .Fa addrcnt argument indicating how many socket addresses are in the passed in array. Note that all of the addresses will only be used when an implicit association is being set up. This allows the user the equivalent behavior as doing a .Fn sctp_connectx followed by a .Fn sctp_send to the association. Note that if the .Fa sinfo->sinfo_assoc_id field is 0, then the first address will be used to look up the association in place of the association id. If both an address and an association id are specified, the association id has priority. .Sh RETURN VALUES The call returns the number of characters sent, or -1 if an error occurred. .Sh ERRORS The .Fn sctp_send system call fails if: .Bl -tag -width Er .It Bq Er EBADF An invalid descriptor was specified. .It Bq Er ENOTSOCK The argument .Fa s is not a socket. .It Bq Er EFAULT An invalid user space address was specified for an argument. .It Bq Er EMSGSIZE The socket requires that message be sent atomically, and the size of the message to be sent made this impossible. .It Bq Er EAGAIN The socket is marked non-blocking and the requested operation would block. .It Bq Er ENOBUFS The system was unable to allocate an internal buffer. The operation may succeed when buffers become available. .It 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. .It Bq Er EHOSTUNREACH The remote host was unreachable. -.It Bq Er ENOTCON +.It Bq Er ENOTCONN On a one-to-one style socket no association exists. .It Bq Er ECONNRESET An abort was received by the stack while the user was attempting to send data to the peer. .It Bq Er ENOENT On a one-to-many style socket no address is specified so that the association cannot be located or the SCTP_ABORT flag was specified on a non-existing association. .It Bq Er EPIPE The socket is unable to send anymore data .Dv ( SBS_CANTSENDMORE has been set on the socket). This typically means that the socket is not connected and is a one-to-one style socket. .El .Sh SEE ALSO .Xr getsockopt 2 , .Xr recv 2 , .Xr select 2 , .Xr sendmsg 2 , .Xr socket 2 , .Xr write 2 .Xr sctp_connectx 3 , .Xr sctp_recvmsg 3 , .Xr sctp_sendmsg 3 , .Xr sctp 4 .Sh BUGS Because .Fn sctp_send may have multiple associations under one endpoint, a select on write will only work for a one-to-one style socket. Index: stable/7/lib/libc/net/sctp_sendmsg.3 =================================================================== --- stable/7/lib/libc/net/sctp_sendmsg.3 (revision 204290) +++ stable/7/lib/libc/net/sctp_sendmsg.3 (revision 204291) @@ -1,333 +1,333 @@ .\" 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 following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. All advertising materials mentioning features or use of this software .\" must display the following acknowledgement: .\" This product includes software developed by the University of .\" California, Berkeley and its contributors. .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" From: @(#)send.2 8.2 (Berkeley) 2/21/94 .\" $FreeBSD$ .\" .Dd December 15, 2006 .Dt SCTP_SENDMSG 3 .Os .Sh NAME .Nm sctp_sendmsg , .Nm sctp_sendmsgx .Nd send a message from an SCTP socket .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In sys/types.h .In sys/socket.h .In netinet/sctp.h .Ft ssize_t .Fo sctp_sendmsg .Fa "int s" "const void *msg" "size_t len" "const struct sockaddr *to" .Fa "socklen_t tolen" "uint32_t ppid" "uint32_t flags" "uint16_t stream_no" .Fa "uint32_t timetolive" "uint32_t context" .Fc .Ft ssize_t .Fo sctp_sendmsgx .Fa "int s" "const void *msg" "size_t len" "const struct sockaddr *to" .Fa "int addrcnt" "uint32_t ppid" "uint32_t flags" "uint16_t stream_no" .Fa "uint32_t timetolive" "uint32_t context" .Fc .Sh DESCRIPTION The .Fn sctp_sendmsg system call is used to transmit a message to another SCTP endpoint. The .Fn sctp_sendmsg may be used at any time. If the socket is a one-to-many type (SOCK_SEQPACKET) socket then an attempt to send to an address that no association exists to will implicitly create a new association. Data sent in such an instance will result in the data being sent on the third leg of the SCTP four-way handshake. Note that if the socket is a one-to-one type (SOCK_STREAM) socket then an association must be in existance (by use of the .Xr connect 2 system call). Calling .Fn sctp_sendmsg or .Fn sctp_sendmsgx on a non-connected one-to-one socket will result in .Va errno being set to .Er ENOTCONN , -1 being returned, and the message not being transmitted. .Pp The address of the target is given by .Fa to with .Fa tolen specifying its size. The length of the message .Fa msg is given by .Fa len . If the message is too long to pass atomically through the underlying protocol, .Va errno is set to .Er EMSGSIZE , -1 is returned, and the message is not transmitted. .Pp No indication of failure to deliver is implicit in a .Xr sctp_sendmsg 2 call. Locally detected errors are indicated by a return value of -1. .Pp If no space is available at the socket to hold the message to be transmitted, then .Xr sctp_sendmsg 2 normally blocks, unless the socket has been placed in non-blocking I/O mode. The .Xr select 2 system call may be used to determine when it is possible to send more data on one-to-one type (SOCK_STREAM) sockets. .Pp The .Fa ppid argument is an opaque 32 bit value that is passed transparently through the stack to the peer endpoint. It will be available on reception of a message (see .Xr sctp_recvmsg 2 ) . Note that the stack passes this value without regard to byte order. .Pp The .Fa flags argument may include one or more of the following: .Bd -literal #define SCTP_EOF 0x0100 /* Start a shutdown procedures */ #define SCTP_ABORT 0x0200 /* Send an ABORT to peer */ #define SCTP_UNORDERED 0x0400 /* Message is un-ordered */ #define SCTP_ADDR_OVER 0x0800 /* Override the primary-address */ #define SCTP_SENDALL 0x1000 /* Send this on all associations */ /* for the endpoint */ /* The lower byte is an enumeration of PR-SCTP policies */ #define SCTP_PR_SCTP_TTL 0x0001 /* Time based PR-SCTP */ #define SCTP_PR_SCTP_BUF 0x0002 /* Buffer based PR-SCTP */ #define SCTP_PR_SCTP_RTX 0x0003 /* Number of retransmissions based PR-SCTP */ .Ed .Pp The flag .Dv SCTP_EOF is used to instruct the SCTP stack to queue this message and then start a graceful shutdown of the association. All remaining data in queue will be sent after which the association will be shut down. .Pp .Dv SCTP_ABORT is used to immediately terminate an association. An abort is sent to the peer and the local TCB is destroyed. .Pp .Dv SCTP_UNORDERED is used to specify that the message being sent has no specific order and should be delivered to the peer application as soon as possible. When this flag is absent messages are delivered in order within the stream they are sent, but without respect to order to peer streams. .Pp The flag .Dv SCTP_ADDR_OVER is used to specify that an specific address should be used. Normally SCTP will use only one of a multi-homed peers addresses as the primary address to send to. By default, no matter what the .Fa to argument is, this primary address is used to send data. By specifying this flag, the user is asking the stack to ignore the primary address and instead use the specified address not only as a lookup mechanism to find the association but also as the actual address to send to. .Pp For a one-to-many type (SOCK_SEQPACKET) socket the flag .Dv SCTP_SENDALL can be used as a convient way to make one send call and have all associations that are under the socket get a copy of the message. Note that this mechanism is quite efficent and makes only one actual copy of the data which is shared by all the associations for sending. .Pp The remaining flags are used for the partial reliability extension (RFC3758) and will only be effective if the peer endpoint supports this extension. This option specifies what local policy the local endpoint should use in skipping data. If none of these options are set, then data is never skipped over. .Pp .Dv SCTP_PR_SCTP_TTL is used to indicate that a time based lifetime is being applied to the data. The .Fa timetolive argument is then a number of milliseconds for which the data is attempted to be transmitted. If that many milliseconds ellapse and the peer has not acknowledged the data, the data will be skipped and no longer transmitted. Note that this policy does not even assure that the data will ever be sent. In times of a congestion with large amounts of data being queued, the .Fa timetolive may expire before the first transmission is ever made. .Pp The .Dv SCTP_PR_SCTP_BUF based policy transforms the .Fa timetolive field into a total number of bytes allowed on the outbound send queue. If that number or more bytes are in queue, then other buffer based sends are looked to be removed and skipped. Note that this policy may also result in the data never being sent if no buffer based sends are in queue and the maximum specified by .Fa timetolive bytes is in queue. .Pp The .Dv SCTP_PR_SCTP_RTX policy transforms the .Fa timetolive into a number of retransmissions to allow. This policy always assures that at a minimum one send attempt is made of the data. After which no more than .Fa timetolive retransmissions will be made before the data is skipped. .Pp .Fa stream_no is the SCTP stream that you wish to send the message on. Streams in SCTP are reliable (or partially reliable) flows of ordered messages. The .Fa context field is used only in the event the message cannot be sent. This is an opaque value that the stack retains and will give to the user when a failed send is given if that notification is enabled (see .Xr sctp 4 ) . Normally a user process can use this value to index some application specific data structure when a send cannot be fulfilled. .Fn sctp_sendmsgx is identical to .Fn sctp_sendmsg with the exception that it takes an array of sockaddr structures in the argument .Fa to and adds the additional argument .Fa addrcnt which specifies how many addresses are in the array. This allows a caller to implicitly set up an association passing multiple addresses as if .Fn sctp_connectx had been called to set up the association. .Sh RETURN VALUES The call returns the number of characters sent, or -1 if an error occurred. .Sh ERRORS The .Fn sctp_sendmsg system call fails if: .Bl -tag -width Er .It Bq Er EBADF An invalid descriptor was specified. .It Bq Er ENOTSOCK The argument .Fa s is not a socket. .It Bq Er EFAULT An invalid user space address was specified for an argument. .It Bq Er EMSGSIZE The socket requires that message be sent atomically, and the size of the message to be sent made this impossible. .It Bq Er EAGAIN The socket is marked non-blocking and the requested operation would block. .It Bq Er ENOBUFS The system was unable to allocate an internal buffer. The operation may succeed when buffers become available. .It 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. .It Bq Er EHOSTUNREACH The remote host was unreachable. -.It Bq Er ENOTCON +.It Bq Er ENOTCONN On a one-to-one style socket no association exists. .It Bq Er ECONNRESET An abort was received by the stack while the user was attempting to send data to the peer. .It Bq Er ENOENT On a one-to-many style socket no address is specified so that the association cannot be located or the .Dv SCTP_ABORT flag was specified on a non-existing association. .It Bq Er EPIPE The socket is unable to send anymore data .Dv ( SBS_CANTSENDMORE has been set on the socket). This typically means that the socket is not connected and is a one-to-one style socket. .El .Sh SEE ALSO .Xr connect 2 , .Xr getsockopt 2 , .Xr recv 2 , .Xr select 2 , .Xr socket 2 , .Xr write 2 , .Xr sctp_connectx 3 , .Xr sendmsg 3 , .Xr sctp 4 .Sh BUGS Because in the one-to-many style socket .Fn sctp_sendmsg or .Fn sctp_sendmsgx may have multiple associations under one endpoint, a select on write will only work for a one-to-one style socket. Index: stable/7/lib/libc/stdtime =================================================================== --- stable/7/lib/libc/stdtime (revision 204290) +++ stable/7/lib/libc/stdtime (revision 204291) Property changes on: stable/7/lib/libc/stdtime ___________________________________________________________________ Modified: svn:mergeinfo ## -0,0 +0,1 ## Merged /head/lib/libc/stdtime:r203322 Index: stable/7/lib/libc =================================================================== --- stable/7/lib/libc (revision 204290) +++ stable/7/lib/libc (revision 204291) Property changes on: stable/7/lib/libc ___________________________________________________________________ Modified: svn:mergeinfo ## -0,0 +0,1 ## Merged /head/lib/libc:r203322