diff options
Diffstat (limited to 'lib/libc/net/sctp_sendmsg.3')
-rw-r--r-- | lib/libc/net/sctp_sendmsg.3 | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/lib/libc/net/sctp_sendmsg.3 b/lib/libc/net/sctp_sendmsg.3 index ddd88b4..4158932 100644 --- a/lib/libc/net/sctp_sendmsg.3 +++ b/lib/libc/net/sctp_sendmsg.3 @@ -72,10 +72,10 @@ 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 existence (by use of the +be in existence (by use of the .Xr connect 2 system call). -Calling +Calling .Fn sctp_sendmsg or .Fn sctp_sendmsgx @@ -90,14 +90,14 @@ The address of the target is given by with .Fa tolen specifying its size. -The length of the message +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 +is set to .Er EMSGSIZE , -1 is returned, and the message is not transmitted. @@ -117,7 +117,7 @@ The 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 +The .Fa ppid argument is an opaque 32 bit value that is passed transparently through the stack to the peer endpoint. @@ -143,7 +143,7 @@ argument may include one or more of the following: #define SCTP_PR_SCTP_RTX 0x0003 /* Number of retransmissions based PR-SCTP */ .Ed .Pp -The flag +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. @@ -170,7 +170,7 @@ 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 +By default, no matter what the .Fa to argument is, this primary address is used to send data. By specifying @@ -205,14 +205,14 @@ 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 +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 +.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 @@ -220,19 +220,19 @@ 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 +the maximum specified by +.Fa timetolive bytes is in queue. .Pp The .Dv SCTP_PR_SCTP_RTX policy transforms the -.Fa timetolive +.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 +After which no more than .Fa timetolive retransmissions will be made before the data is skipped. .Pp @@ -241,7 +241,7 @@ 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 +The .Fa context field is used only in the event the message cannot be sent. This is an opaque @@ -251,7 +251,7 @@ is given if that notification is enabled (see 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 +is identical to .Fn sctp_sendmsg with the exception that it takes an array of sockaddr structures in the argument @@ -262,7 +262,7 @@ 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 +.Fn sctp_connectx had been called to set up the association. .Sh RETURN VALUES The call returns the number of characters sent, or -1 @@ -325,7 +325,7 @@ is not connected and is a one-to-one style socket. .Xr sctp 4 .Sh BUGS Because in the one-to-many style socket -.Fn sctp_sendmsg +.Fn sctp_sendmsg or .Fn sctp_sendmsgx may have multiple associations under one endpoint, a |