diff options
author | brueffer <brueffer@FreeBSD.org> | 2007-09-25 16:48:08 +0000 |
---|---|---|
committer | brueffer <brueffer@FreeBSD.org> | 2007-09-25 16:48:08 +0000 |
commit | a55c6d7befa8065900c87b663c46ad1be839f7dd (patch) | |
tree | a36d7339ea860d997d458dedf750a6ad5bf4a9e1 /lib/libc/net/sctp_send.3 | |
parent | a0d2ad9bdb9ce04037f0f6228a82dbe2cae38899 (diff) | |
download | FreeBSD-src-a55c6d7befa8065900c87b663c46ad1be839f7dd.zip FreeBSD-src-a55c6d7befa8065900c87b663c46ad1be839f7dd.tar.gz |
Assorted spelling, punctuation and mdoc fixes.
Approved by: re (blanket)
Diffstat (limited to 'lib/libc/net/sctp_send.3')
-rw-r--r-- | lib/libc/net/sctp_send.3 | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/lib/libc/net/sctp_send.3 b/lib/libc/net/sctp_send.3 index c44e992..2301730 100644 --- a/lib/libc/net/sctp_send.3 +++ b/lib/libc/net/sctp_send.3 @@ -75,10 +75,10 @@ is set to the message is not transmitted. .Pp No indication of failure to deliver is implicit in a -.Fn sctp_send +.Fn sctp_send . Locally detected errors are indicated by a return value of -1. .Pp -If no messages space is available at the socket to hold +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 @@ -111,8 +111,7 @@ The 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 -). +.Xr sctp_recvmsg 2 ) . Note that the stack passes this value without regard to byte order. .Pp @@ -174,7 +173,7 @@ 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 reliabilty extension (RFC3758) +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. @@ -182,7 +181,7 @@ 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 +is used to indicate that a time based lifetime is being applied to the data. The .Fa sinfo->sinfo_timetolive @@ -206,7 +205,8 @@ 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 +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 @@ -233,16 +233,16 @@ messages. The .Fa sinfo->sinfo_assoc_id field is used to -select the association to send to on an one-to-many socket. +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 -). +.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 @@ -275,7 +275,7 @@ 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 equivilant behavior as doing a +user the equivalent behavior as doing a .Fn sctp_connectx followed by a .Fn sctp_send |