d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Assorted spelling, punctuation and mdoc fixes.

Browse Source 
Approved by:	re (blanket)
This commit is contained in:
brueffer 2007-09-25 16:48:08 +00:00
parent a0d2ad9bdb
commit a55c6d7bef
5 changed files with 39 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/libc/net/sctp_connectx.3
View File

@ -36,7 +36,7 @@
.Os
.Sh NAME
.Nm sctp_connectx
.Nd connect an sctp socket with multiple destination addresses.
.Nd connect an SCTP socket with multiple destination addresses.
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS

2
lib/libc/net/sctp_opt_info.3
View File

@ -37,7 +37,7 @@
.Os
.Sh NAME
.Nm sctp_opt_info
.Nd get sctp socket information
.Nd get SCTP socket information
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS

25
lib/libc/net/sctp_recvmsg.3
View File

@ -60,8 +60,8 @@ successful
.Fn connect
call or after the application has performed a
.Fn listen
followed by a sucessful
.Fn accept
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
@ -73,7 +73,7 @@ and
Or, an application may also receive a message after having
called
.Fn listen
with a postive backlog to enable the reception of new associations.
with a positive backlog to enable the reception of new associations.
.Pp
The address of the sender is held in the
.Fa from
@ -99,7 +99,9 @@ to be received is bounded by
If the message is too long to fit in the users
receive buffer, then the
.Fa flags
argument will NOT have the
argument will
.Em not
have the
.Dv MSG_EOF
flag applied.
If the message is a complete message then
@ -117,7 +119,9 @@ The
argument may also hold the value
.Dv MSG_NOTIFICATION .
When this
occurs this indicates that the message received is NOT from
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
@ -194,7 +198,9 @@ association.
The
.Fa sinfo->sinfo_ssn
will hold the stream sequence number assigned
by the peer endpoint if the message is NOT unordered.
by the peer endpoint if the message is
.Em not
unordered.
For unordered messages this field holds an undefined value.
.Pp
The
@ -203,8 +209,8 @@ 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 TSN's this
value will be one of the TSN's that was used on the
Note that for messages that span multiple TSNs this
value will be one of the TSNs that was used on the
message.
.Pp
The
@ -224,8 +230,7 @@ the use of an address field.
It is also quite useful in
setting various socket options on the specific association
(see
.Xr sctp 4
).
.Xr sctp 4 ) .
.Pp
The
.Fa sinfo->info_timetolive

22
lib/libc/net/sctp_send.3
View File

@ -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

24
lib/libc/net/sctp_sendmsg.3
View File

@ -123,8 +123,7 @@ 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
@ -186,15 +185,15 @@ 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 specify's what local policy the local endpoint should use
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
is used to indicate that a time based lifetime is being applied
to the data.
The
.Fa timetolive
@ -248,30 +247,29 @@ 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.
.Fn sctp_sendmsgx
is identical to
.Fn sctp_sendmsg
with the exception that it takes a array of sockaddr structures in the
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 implictly setup an association passing multiple addresses
as if an
caller to implicitly set up an association passing multiple addresses
as if
.Fn sctp_connectx
had been called to setup the association.
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 2
.Fn sctp_sendmsg
system call
fail if:
.Bl -tag -width Er
@ -322,8 +320,8 @@ is not connected and is a one-to-one style socket.
.Xr select 2 ,
.Xr socket 2 ,
.Xr write 2 ,
.Xr sendmsg 3 ,
.Xr sctp_connectx 3 ,
.Xr sendmsg 3 ,
.Xr sctp 4
.Sh BUGS
Because in the one-to-many style socket the