summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/sctp.4 3.html
diff options
context:
space:
mode:
Diffstat (limited to 'static/freebsd/man4/sctp.4 3.html')
-rw-r--r--static/freebsd/man4/sctp.4 3.html497
1 files changed, 0 insertions, 497 deletions
diff --git a/static/freebsd/man4/sctp.4 3.html b/static/freebsd/man4/sctp.4 3.html
deleted file mode 100644
index ad1dcf06..00000000
--- a/static/freebsd/man4/sctp.4 3.html
+++ /dev/null
@@ -1,497 +0,0 @@
-<table class="head">
- <tr>
- <td class="head-ltitle">SCTP(4)</td>
- <td class="head-vol">Device Drivers Manual</td>
- <td class="head-rtitle">SCTP(4)</td>
- </tr>
-</table>
-<div class="manual-text">
-<section class="Sh">
-<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
-<p class="Pp"><code class="Nm">sctp</code> &#x2014; <span class="Nd">Internet
- Stream Control Transmission Protocol</span></p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
-<p class="Pp"><code class="Cd">options SCTP</code>
- <br/>
- <code class="Cd">options SCTP_SUPPORT</code></p>
-<p class="Pp">
- <br/>
- <code class="In">#include &lt;<a class="In">sys/types.h</a>&gt;</code>
- <br/>
- <code class="In">#include &lt;<a class="In">sys/socket.h</a>&gt;</code>
- <br/>
- <code class="In">#include &lt;<a class="In">netinet/sctp.h</a>&gt;</code></p>
-<p class="Pp"><var class="Ft">int</var>
- <br/>
- <code class="Fn">socket</code>(<var class="Fa" style="white-space: nowrap;">AF_INET</var>,
- <var class="Fa" style="white-space: nowrap;">SOCK_STREAM</var>,
- <var class="Fa" style="white-space: nowrap;">IPPROTO_SCTP</var>);</p>
-<p class="Pp"><var class="Ft">int</var>
- <br/>
- <code class="Fn">socket</code>(<var class="Fa" style="white-space: nowrap;">AF_INET</var>,
- <var class="Fa" style="white-space: nowrap;">SOCK_SEQPACKET</var>,
- <var class="Fa" style="white-space: nowrap;">IPPROTO_SCTP</var>);</p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
-<p class="Pp">The SCTP protocol provides reliable, flow-controlled, two-way
- transmission of data. It is a message oriented protocol and can support the
- <code class="Dv">SOCK_STREAM</code> and
- <code class="Dv">SOCK_SEQPACKET</code> abstractions. SCTP uses the standard
- Internet address format and, in addition, provides a per-host collection of
- &#x201C;port addresses&#x201D;. Thus, each address is composed of an
- Internet address specifying the host and network, with a specific SCTP port
- on the host identifying the peer entity.</p>
-<p class="Pp">There are two models of programming in SCTP. The first uses the
- <code class="Dv">SOCK_STREAM</code> abstraction. In this abstraction sockets
- utilizing the SCTP protocol are either &#x201C;active&#x201D; or
- &#x201C;passive&#x201D;. Active sockets initiate connections to passive
- sockets. By default, SCTP sockets are created active; to create a passive
- socket, the <a class="Xr">listen(2)</a> system call must be used after
- binding the socket with the <a class="Xr">bind(2)</a> or
- <a class="Xr">sctp_bindx(3)</a> system calls. Only passive sockets may use
- the <a class="Xr">accept(2)</a> call to accept incoming connections. Only
- active sockets may use the <a class="Xr">connect(2)</a> call to initiate
- connections.</p>
-<p class="Pp">The other abstraction <code class="Dv">SOCK_SEQPACKET</code>
- provides a &#x201C;connectionless&#x201D; mode of operation in that the user
- may send to an address (using any of the valid send calls that carry a
- socket address) and an association will be setup implicitly by the
- underlying SCTP transport stack. This abstraction is the only one capable of
- sending data on the third leg of the four-way handshake. A user must still
- call <a class="Xr">listen(2)</a> to allow the socket to accept connections.
- Calling <a class="Xr">listen(2)</a> however does not restrict the user from
- still initiating implicit connections to other peers.</p>
-<p class="Pp">The SCTP protocol directly supports multi-homing. So when binding
- a socket with the &#x201C;wildcard&#x201D; address
- <code class="Dv">INADDR_ANY</code>, the SCTP stack will inform the peer
- about all of the local addresses that are deemed in scope of the peer. The
- peer will then possibly have multiple paths to reach the local host.</p>
-<p class="Pp">The SCTP transport protocol is also multi-streamed.
- Multi-streaming refers to the ability to send sub-ordered flows of messages.
- A user performs this by specifying a specific stream in one of the extended
- send calls such as the <a class="Xr">sctp_send(3)</a> function call. Sending
- messages on different streams will allow parallel delivery of data i.e., a
- message loss in stream 1 will not block the delivery of messages sent in
- stream 2.</p>
-<p class="Pp">The SCTP transport protocol also provides a unordered service as
- well. The unordered service allows a message to be sent and delivered with
- no regard to the ordering of any other message.</p>
-<p class="Pp">The SCTP kernel implementation may either be compiled into the
- kernel, or loaded dynamically as a module. To support dynamic loading of the
- stack, the kernel must be compiled with <code class="Cd">options
- SCTP_SUPPORT</code>.</p>
-<section class="Ss">
-<h2 class="Ss" id="Extensions"><a class="permalink" href="#Extensions">Extensions</a></h2>
-<p class="Pp">The <span class="Ux">FreeBSD</span> implementation of SCTP also
- supports the following extensions:</p>
-<dl class="Bl-tag">
- <dt>sctp partial reliability</dt>
- <dd>This extension allows one to have message be skipped and not delivered
- based on some user specified parameters.</dd>
- <dt>sctp dynamic addressing</dt>
- <dd>This extension allows addresses to be added and deleted dynamically from
- an existing association.</dd>
- <dt>sctp authentication</dt>
- <dd>This extension allows the user to authenticate specific peer chunks
- (including data) to validate that the peer who sent the message is in fact
- the peer who setup the association. A shared key option is also provided
- for so that two stacks can pre-share keys.</dd>
- <dt>packet drop</dt>
- <dd>Some routers support a special satellite protocol that will report losses
- due to corruption. This allows retransmissions without subsequent loss in
- bandwidth utilization.</dd>
- <dt>stream reset</dt>
- <dd>This extension allows a user on either side to reset the stream sequence
- numbers used by any or all streams.</dd>
-</dl>
-</section>
-<section class="Ss">
-<h2 class="Ss" id="Socket_Options"><a class="permalink" href="#Socket_Options">Socket
- Options</a></h2>
-<p class="Pp">SCTP supports a number of socket options which can be set with
- <a class="Xr">setsockopt(2)</a> and tested with
- <a class="Xr">getsockopt(2)</a> or <a class="Xr">sctp_opt_info(3)</a>:</p>
-<dl class="Bl-tag">
- <dt id="SCTP_NODELAY"><a class="permalink" href="#SCTP_NODELAY"><code class="Dv">SCTP_NODELAY</code></a></dt>
- <dd>Under most circumstances, SCTP sends data when it is presented; when
- outstanding data has not yet been acknowledged, it gathers small amounts
- of output to be sent in a single packet once an acknowledgement is
- received. For some clients, such as window systems that send a stream of
- mouse events which receive no replies, this packetization may cause
- significant delays. The boolean option
- <code class="Dv">SCTP_NODELAY</code> defeats this algorithm.</dd>
- <dt id="SCTP_RTOINFO"><a class="permalink" href="#SCTP_RTOINFO"><code class="Dv">SCTP_RTOINFO</code></a></dt>
- <dd>This option returns specific information about an associations
- &#x201C;Retransmission Time Out&#x201D;. It can also be used to change the
- default values.</dd>
- <dt id="SCTP_ASSOCINFO"><a class="permalink" href="#SCTP_ASSOCINFO"><code class="Dv">SCTP_ASSOCINFO</code></a></dt>
- <dd>This option returns specific information about the requested
- association.</dd>
- <dt id="SCTP_INITMSG"><a class="permalink" href="#SCTP_INITMSG"><code class="Dv">SCTP_INITMSG</code></a></dt>
- <dd>This option allows you to get or set the default sending parameters when
- an association is implicitly setup. It allows you to change such things as
- the maximum number of streams allowed inbound and the number of streams
- requested of the peer.</dd>
- <dt id="SCTP_AUTOCLOSE"><a class="permalink" href="#SCTP_AUTOCLOSE"><code class="Dv">SCTP_AUTOCLOSE</code></a></dt>
- <dd>For the one-to-many model (<code class="Dv">SOCK_SEQPACKET</code>)
- associations are setup implicitly. This option allows the user to specify
- a default number of idle seconds to allow the association be maintained.
- After the idle timer (where no user message have been sent or have been
- received from the peer) the association will be gracefully closed. The
- default for this value is 0, or unlimited (i.e., no automatic close).</dd>
- <dt id="SCTP_SET_PEER_PRIMARY_ADDR"><a class="permalink" href="#SCTP_SET_PEER_PRIMARY_ADDR"><code class="Dv">SCTP_SET_PEER_PRIMARY_ADDR</code></a></dt>
- <dd>The dynamic address extension allows a peer to also request a particular
- address of its be made into the primary address. This option allows the
- caller to make such a request to a peer. Note that if the peer does not
- also support the dynamic address extension, this call will fail. Note the
- caller must provide a valid local address that the peer has been told
- about during association setup or dynamically.</dd>
- <dt id="SCTP_PRIMARY_ADDR"><a class="permalink" href="#SCTP_PRIMARY_ADDR"><code class="Dv">SCTP_PRIMARY_ADDR</code></a></dt>
- <dd>This option allows the setting of the primary address that the caller
- wishes to send to. The caller provides the address of a peer that is to be
- made primary.</dd>
- <dt id="SCTP_ADAPTATION_LAYER"><a class="permalink" href="#SCTP_ADAPTATION_LAYER"><code class="Dv">SCTP_ADAPTATION_LAYER</code></a></dt>
- <dd>The dynamic address extension also allows a user to pass a 32 bit opaque
- value upon association setup. This option allows a user to set or get this
- value.</dd>
- <dt id="SCTP_DISABLE_FRAGMENTS"><a class="permalink" href="#SCTP_DISABLE_FRAGMENTS"><code class="Dv">SCTP_DISABLE_FRAGMENTS</code></a></dt>
- <dd>By default SCTP will fragment user messages into multiple pieces that will
- fit on the network and then later, upon reception, reassemble the pieces
- into a single user message. If this option is enabled instead, any send
- that exceeds the path maximum transfer unit (P-MTU) will fail and the
- message will NOT be sent.</dd>
- <dt id="SCTP_PEER_ADDR_PARAMS"><a class="permalink" href="#SCTP_PEER_ADDR_PARAMS"><code class="Dv">SCTP_PEER_ADDR_PARAMS</code></a></dt>
- <dd>This option will allow a user to set or get specific peer address
- parameters.</dd>
- <dt id="SCTP_DEFAULT_SEND_PARAM"><a class="permalink" href="#SCTP_DEFAULT_SEND_PARAM"><code class="Dv">SCTP_DEFAULT_SEND_PARAM</code></a></dt>
- <dd>When a user does not use one of the extended send calls (e.g.,
- <a class="Xr">sctp_sendmsg(3)</a>) a set of default values apply to each
- send. These values include things like the stream number to send to as
- well as the per-protocol id. This option lets a caller both get and set
- these values. If the user changes these default values, then these new
- values will be used as the default whenever no information is provided by
- the sender (i.e., the non-extended API is used).</dd>
- <dt id="SCTP_EVENTS"><a class="permalink" href="#SCTP_EVENTS"><code class="Dv">SCTP_EVENTS</code></a></dt>
- <dd>SCTP has non-data events that it can communicate to its application. By
- default these are all disabled since they arrive in the data path with a
- special flag <code class="Dv">MSG_NOTIFICATION</code> set upon the
- received message. This option lets a caller both get what events are
- current being received as well as set different events that they may be
- interested in receiving.</dd>
- <dt id="SCTP_I_WANT_MAPPED_V4_ADDR"><a class="permalink" href="#SCTP_I_WANT_MAPPED_V4_ADDR"><code class="Dv">SCTP_I_WANT_MAPPED_V4_ADDR</code></a></dt>
- <dd>SCTP supports both IPV4 and IPV6. An association may span both IPV4 and
- IPV6 addresses since SCTP is multi-homed. By default, when opening an IPV6
- socket, when data arrives on the socket from a peer's V4 address the V4
- address will be presented with an address family of AF_INET. If this is
- undesirable, then this option can be enabled which will then convert all
- V4 addresses into mapped V6 representations.</dd>
- <dt id="SCTP_MAXSEG"><a class="permalink" href="#SCTP_MAXSEG"><code class="Dv">SCTP_MAXSEG</code></a></dt>
- <dd>By default SCTP chooses its message fragmentation point based upon the
- smallest P-MTU of the peer. This option lets the caller set it to a
- smaller value. Note that while the user can change this value, if the
- P-MTU is smaller than the value set by the user, then the P-MTU value will
- override any user setting.</dd>
- <dt id="SCTP_DELAYED_SACK"><a class="permalink" href="#SCTP_DELAYED_SACK"><code class="Dv">SCTP_DELAYED_SACK</code></a></dt>
- <dd>This option lets the user both set and get the delayed ack time (in
- milliseconds) and the ack frequency that SCTP is using. The default
- delayed ack time is 200 milliseconds and the default ack frequency is
- 2.</dd>
- <dt id="SCTP_PARTIAL_DELIVERY_POINT"><a class="permalink" href="#SCTP_PARTIAL_DELIVERY_POINT"><code class="Dv">SCTP_PARTIAL_DELIVERY_POINT</code></a></dt>
- <dd>SCTP at times may need to start delivery of a very large message before
- the entire message has arrived. By default SCTP waits until the incoming
- message is larger than one fourth of the receive buffer. This option
- allows the stacks value to be overridden with a smaller value.</dd>
- <dt id="SCTP_FRAGMENT_INTERLEAVE"><a class="permalink" href="#SCTP_FRAGMENT_INTERLEAVE"><code class="Dv">SCTP_FRAGMENT_INTERLEAVE</code></a></dt>
- <dd>SCTP at times will start partial delivery (as mentioned above). In the
- normal case successive reads will continue to return the rest of the
- message, blocking if needed, until all of that message is read. However
- this means other messages may have arrived and be ready for delivery and
- be blocked behind the message being partially delivered. If this option is
- enabled, when a partial delivery message has no more data to be received,
- then a subsequent read may return a different message that is ready for
- delivery. By default this option is off since the user must be using the
- extended API's to be able to tell the difference between messages (via the
- stream and stream sequence number).</dd>
- <dt id="SCTP_AUTH_CHUNK"><a class="permalink" href="#SCTP_AUTH_CHUNK"><code class="Dv">SCTP_AUTH_CHUNK</code></a></dt>
- <dd>By default only the dynamic addressing chunks are authenticated. This
- option lets a user request an additional chunk be authenticated as well.
- Note that successive calls to this option will work and continue to add
- more chunks that require authentication. Note that this option only
- effects future associations and not existing ones.</dd>
- <dt id="SCTP_AUTH_KEY"><a class="permalink" href="#SCTP_AUTH_KEY"><code class="Dv">SCTP_AUTH_KEY</code></a></dt>
- <dd>This option allows a user to specify a shared key that can be later used
- to authenticate a peer.</dd>
- <dt id="SCTP_HMAC_IDENT"><a class="permalink" href="#SCTP_HMAC_IDENT"><code class="Dv">SCTP_HMAC_IDENT</code></a></dt>
- <dd>This option will let you get or set the list of HMAC algorithms used to
- authenticate peers. Note that the HMAC values are in priority order where
- the first HMAC identifier is the most preferred and the last is the least
- preferred.</dd>
- <dt id="SCTP_AUTH_ACTIVE_KEY"><a class="permalink" href="#SCTP_AUTH_ACTIVE_KEY"><code class="Dv">SCTP_AUTH_ACTIVE_KEY</code></a></dt>
- <dd>This option allows you to make a key active for the generation of
- authentication information. Note that the peer must have the same key or
- else the data will be discarded.</dd>
- <dt id="SCTP_AUTH_DELETE_KEY"><a class="permalink" href="#SCTP_AUTH_DELETE_KEY"><code class="Dv">SCTP_AUTH_DELETE_KEY</code></a></dt>
- <dd>This option allows you to delete an old key.</dd>
- <dt id="SCTP_USE_EXT_RECVINFO"><a class="permalink" href="#SCTP_USE_EXT_RECVINFO"><code class="Dv">SCTP_USE_EXT_RECVINFO</code></a></dt>
- <dd>The sockets api document allows an extended send/receive information
- structure to be used. The extended structure includes additional fields
- related to the next message to be received (after the current receive
- completes) if such information is known. By default the system will not
- pass this information. This option allows the user to request this
- information.</dd>
- <dt id="SCTP_AUTO_ASCONF"><a class="permalink" href="#SCTP_AUTO_ASCONF"><code class="Dv">SCTP_AUTO_ASCONF</code></a></dt>
- <dd>By default when bound to all address and the system administrator has
- enables automatic dynamic addresses, the SCTP stack will automatically
- generate address changes into add and delete requests to any peers by
- setting this option to true. This option allows an endpoint to disable
- that behavior.</dd>
- <dt id="SCTP_MAXBURST"><a class="permalink" href="#SCTP_MAXBURST"><code class="Dv">SCTP_MAXBURST</code></a></dt>
- <dd>By default SCTP implements micro-burst control so that as the congestion
- window opens up no large burst of packets can be generated. The default
- burst limit is four. This option lets the user change this value.</dd>
- <dt id="SCTP_CONTEXT"><a class="permalink" href="#SCTP_CONTEXT"><code class="Dv">SCTP_CONTEXT</code></a></dt>
- <dd>Many sctp extended calls have a context field. The context field is a 32
- bit opaque value that will be returned in send failures. This option lets
- the caller set the default context value to use when none is provided by
- the user.</dd>
- <dt id="SCTP_EXPLICIT_EOR"><a class="permalink" href="#SCTP_EXPLICIT_EOR"><code class="Dv">SCTP_EXPLICIT_EOR</code></a></dt>
- <dd>By default, a single send is a complete message. SCTP generates an implied
- record boundary. If this option is enabled, then all sends are part of the
- same message until the user indicates an end of record with the special
- flag <code class="Dv">SCTP_EOR</code> passed in the sctp_sndrcvinfo flags
- field. This effectively makes all sends part of the same message until the
- user specifies differently. This means that a caller must NOT change the
- stream number until after the <code class="Dv">SCTP_EOR</code> is passed
- to SCTP else an error will be returned.</dd>
- <dt id="SCTP_STATUS"><a class="permalink" href="#SCTP_STATUS"><code class="Dv">SCTP_STATUS</code></a></dt>
- <dd>This option is a read-only option that returns various status information
- about the specified association.</dd>
- <dt id="SCTP_GET_PEER_ADDR_INFO"><a class="permalink" href="#SCTP_GET_PEER_ADDR_INFO"><code class="Dv">SCTP_GET_PEER_ADDR_INFO</code></a></dt>
- <dd>This read-only option returns information about a peer address.</dd>
- <dt id="SCTP_PEER_AUTH_CHUNKS"><a class="permalink" href="#SCTP_PEER_AUTH_CHUNKS"><code class="Dv">SCTP_PEER_AUTH_CHUNKS</code></a></dt>
- <dd>This read-only option returns a list of the chunks the peer requires to be
- authenticated.</dd>
- <dt id="SCTP_LOCAL_AUTH_CHUNKS"><a class="permalink" href="#SCTP_LOCAL_AUTH_CHUNKS"><code class="Dv">SCTP_LOCAL_AUTH_CHUNKS</code></a></dt>
- <dd>This read-only option returns a list of the locally required chunks that
- must be authenticated.</dd>
- <dt id="SCTP_RESET_STREAMS"><a class="permalink" href="#SCTP_RESET_STREAMS"><code class="Dv">SCTP_RESET_STREAMS</code></a></dt>
- <dd>This socket option is used to cause a stream sequence number or all stream
- sequence numbers to be reset. Note that the peer SCTP endpoint must also
- support the stream reset extension as well.</dd>
-</dl>
-</section>
-<section class="Ss">
-<h2 class="Ss" id="MIB_Variables"><a class="permalink" href="#MIB_Variables">MIB
- Variables</a></h2>
-<p class="Pp">The SCTP protocol implements a number of variables in the
- <var class="Va">net.inet.sctp</var> branch of the
- <a class="Xr">sysctl(3)</a> MIB.</p>
-<dl class="Bl-ohang">
- <dt id="Congestion"><a class="permalink" href="#Congestion"><b class="Sy">Congestion
- Control</b></a></dt>
- <dd>
- <dl class="Bl-tag">
- <dt id="default_cc_module"><var class="Va">default_cc_module</var></dt>
- <dd>Default congestion control module. Default value is 0. The minimum is
- 0, and the maximum is 3. A value of 0 enables the default congestion
- control algorithm. A value of 1 enables the High Speed congestion
- control algorithm. A value of 2 enables the HTCP congestion control
- algorithm. A value of 3 enables the data center congestion control
- (DCCC) algorithm.</dd>
- <dt id="initial_cwnd"><var class="Va">initial_cwnd</var></dt>
- <dd>Defines the initial congestion window size in MTUs.</dd>
- <dt id="cwnd_maxburst"><var class="Va">cwnd_maxburst</var></dt>
- <dd>Use congestion control instead of 'blind' logic to limit maximum burst
- when sending. Default value is 1. May be set to 0 or 1.</dd>
- <dt id="ecn_enable"><var class="Va">ecn_enable</var></dt>
- <dd>Enable Explicit Congestion Notification (ECN). Default value is 1. May
- be set to 0 or 1.</dd>
- <dt id="rttvar_steady_step"><var class="Va">rttvar_steady_step</var></dt>
- <dd>Number of identical bandwidth measurements DCCC takes to try step down
- the congestion window. Default value is 20. The minimum is 0, and the
- maximum is 65535.</dd>
- <dt id="rttvar_eqret"><var class="Va">rttvar_eqret</var></dt>
- <dd>Whether DCCC reduces the congestion window size when round-trip time
- and bandwidth remain unchanged. Default value is 0. May be set to 0 or
- 1.</dd>
- <dt id="rttvar_bw"><var class="Va">rttvar_bw</var></dt>
- <dd>Shift amount DCCC uses for bandwidth smoothing on round-trip-time
- calculation. Default value is 4. The minimum is 0, and the maximum is
- 32.</dd>
- <dt id="rttvar_rtt"><var class="Va">rttvar_rtt</var></dt>
- <dd>Shift amount DCCC uses for round-trip-time smoothing on
- round-trip-time calculation. Default value is 5. The minimum is 0, and
- the maximum is 32.</dd>
- <dt id="use_dcccecn"><var class="Va">use_dcccecn</var></dt>
- <dd>Enable ECN when using DCCC. Default value is 1. May be set to 0 or
- 1.</dd>
- </dl>
- </dd>
- <dt id="Misc"><a class="permalink" href="#Misc"><b class="Sy">Misc</b></a></dt>
- <dd>
- <dl class="Bl-tag">
- <dt id="getcred"><var class="Va">getcred</var></dt>
- <dd>Get the ucred of a SCTP connection.</dd>
- <dt id="assoclist"><var class="Va">assoclist</var></dt>
- <dd>List of active SCTP associations.</dd>
- <dt id="stats"><var class="Va">stats</var></dt>
- <dd>SCTP statistics (struct sctp_stat).</dd>
- <dt id="diag_info_code"><var class="Va">diag_info_code</var></dt>
- <dd>Diagnostic information error cause code.</dd>
- <dt id="blackhole"><var class="Va">blackhole</var></dt>
- <dd>Enable SCTP blackholing. See <a class="Xr">blackhole(4)</a> for more
- details.</dd>
- <dt id="sendall_limit"><var class="Va">sendall_limit</var></dt>
- <dd>Maximum message size (in bytes) that can be transmitted with
- SCTP_SENDALL flags set.</dd>
- <dt id="buffer_splitting"><var class="Va">buffer_splitting</var></dt>
- <dd>Enable send/receive buffer splitting.</dd>
- <dt id="vtag_time_wait"><var class="Va">vtag_time_wait</var></dt>
- <dd>Vtag wait time in seconds, 0 to disable.</dd>
- <dt id="nat_friendly_init"><var class="Va">nat_friendly_init</var></dt>
- <dd>Enable sending of the NAT-friendly SCTP option on INITs.</dd>
- <dt id="enable_sack_immediately"><var class="Va">enable_sack_immediately</var></dt>
- <dd>Enable sending of the SACK-IMMEDIATELY bit.</dd>
- <dt id="udp_tunneling_port"><var class="Va">udp_tunneling_port</var></dt>
- <dd>Set the SCTP/UDP tunneling port.</dd>
- <dt id="mobility_fasthandoff"><var class="Va">mobility_fasthandoff</var></dt>
- <dd>Enable SCTP fast handoff.</dd>
- <dt id="mobility_base"><var class="Va">mobility_base</var></dt>
- <dd>Enable SCTP base mobility</dd>
- <dt id="default_frag_interleave"><var class="Va">default_frag_interleave</var></dt>
- <dd>Default fragment interleave level.</dd>
- <dt id="default_ss_module"><var class="Va">default_ss_module</var></dt>
- <dd>Default stream scheduling module.</dd>
- <dt id="log_level"><var class="Va">log_level</var></dt>
- <dd>Ltrace/KTR trace logging level.</dd>
- <dt id="max_retran_chunk"><var class="Va">max_retran_chunk</var></dt>
- <dd>Number of retransmissions of a DATA chunk before an association is
- aborted.</dd>
- <dt id="min_residual"><var class="Va">min_residual</var></dt>
- <dd>Minimum residual data chunk in second part of split.</dd>
- <dt id="strict_data_order"><var class="Va">strict_data_order</var></dt>
- <dd>Enforce strict data ordering, abort if control inside data.</dd>
- <dt id="abort_at_limit"><var class="Va">abort_at_limit</var></dt>
- <dd>Abort when one-to-one hits qlimit.</dd>
- <dt id="hb_max_burst"><var class="Va">hb_max_burst</var></dt>
- <dd>Confirmation heartbeat max burst.</dd>
- <dt id="do_sctp_drain"><var class="Va">do_sctp_drain</var></dt>
- <dd>Flush chunks in receive queues with TSN higher than the cumulative TSN
- if the system is low on mbufs.</dd>
- <dt id="max_chained_mbufs"><var class="Va">max_chained_mbufs</var></dt>
- <dd>Default max number of small mbufs on a chain.</dd>
- <dt id="abc_l_var"><var class="Va">abc_l_var</var></dt>
- <dd>SCTP ABC max increase per SACK (L).</dd>
- <dt id="nat_friendly"><var class="Va">nat_friendly</var></dt>
- <dd>SCTP NAT friendly operation.</dd>
- <dt id="cmt_use_dac"><var class="Va">cmt_use_dac</var></dt>
- <dd>CMT DAC on/off flag.</dd>
- <dt id="cmt_on_off"><var class="Va">cmt_on_off</var></dt>
- <dd>CMT settings.</dd>
- <dt id="outgoing_streams"><var class="Va">outgoing_streams</var></dt>
- <dd>Default number of outgoing streams.</dd>
- <dt id="incoming_streams"><var class="Va">incoming_streams</var></dt>
- <dd>Default number of incoming streams.</dd>
- <dt id="add_more_on_output"><var class="Va">add_more_on_output</var></dt>
- <dd>When space-wise is it worthwhile to try to add more to a socket send
- buffer.</dd>
- <dt id="path_pf_threshold"><var class="Va">path_pf_threshold</var></dt>
- <dd>Default potentially failed threshold.</dd>
- <dt id="path_rtx_max"><var class="Va">path_rtx_max</var></dt>
- <dd>Default maximum of retransmissions per path.</dd>
- <dt id="assoc_rtx_max"><var class="Va">assoc_rtx_max</var></dt>
- <dd>Default maximum number of retransmissions per association.</dd>
- <dt id="init_rtx_max"><var class="Va">init_rtx_max</var></dt>
- <dd>Default maximum number of retransmissions for INIT chunks.</dd>
- <dt id="valid_cookie_life"><var class="Va">valid_cookie_life</var></dt>
- <dd>Default cookie lifetime in seconds.</dd>
- <dt id="init_rto_max"><var class="Va">init_rto_max</var></dt>
- <dd>Default maximum retransmission timeout during association setup in
- ms.</dd>
- <dt id="rto_initial"><var class="Va">rto_initial</var></dt>
- <dd>Default initial retransmission timeout in ms.</dd>
- <dt id="rto_min"><var class="Va">rto_min</var></dt>
- <dd>Default minimum retransmission timeout in ms.</dd>
- <dt id="rto_max"><var class="Va">rto_max</var></dt>
- <dd>Default maximum retransmission timeout in ms.</dd>
- <dt id="secret_lifetime"><var class="Va">secret_lifetime</var></dt>
- <dd>Default secret lifetime in seconds.</dd>
- <dt id="shutdown_guard_time"><var class="Va">shutdown_guard_time</var></dt>
- <dd>Shutdown guard timer in seconds (0 means 5 times RTO.Max).</dd>
- <dt id="pmtu_raise_time"><var class="Va">pmtu_raise_time</var></dt>
- <dd>Default PMTU raise timer in seconds.</dd>
- <dt id="heartbeat_interval"><var class="Va">heartbeat_interval</var></dt>
- <dd>Default heartbeat interval in ms.</dd>
- <dt id="asoc_resource"><var class="Va">asoc_resource</var></dt>
- <dd>Max number of cached resources in an association.</dd>
- <dt id="sys_resource"><var class="Va">sys_resource</var></dt>
- <dd>Max number of cached resources in the system.</dd>
- <dt id="sack_freq"><var class="Va">sack_freq</var></dt>
- <dd>Default SACK frequency.</dd>
- <dt id="delayed_sack_time"><var class="Va">delayed_sack_time</var></dt>
- <dd>Default delayed SACK timer in ms.</dd>
- <dt id="chunkscale"><var class="Va">chunkscale</var></dt>
- <dd>Tunable for scaling of number of chunks and messages.</dd>
- <dt id="min_split_point"><var class="Va">min_split_point</var></dt>
- <dd>Minimum size when splitting a chunk.</dd>
- <dt id="pcbhashsize"><var class="Va">pcbhashsize</var></dt>
- <dd>Tunable for PCB hash table sizes.</dd>
- <dt id="tcbhashsize"><var class="Va">tcbhashsize</var></dt>
- <dd>Tunable for TCB hash table sizes.</dd>
- <dt id="maxchunks"><var class="Va">maxchunks</var></dt>
- <dd>Default max chunks on queue per association.</dd>
- <dt id="fr_maxburst"><var class="Va">fr_maxburst</var></dt>
- <dd>Default max burst for SCTP endpoints when fast retransmitting.</dd>
- <dt id="maxburst"><var class="Va">maxburst</var></dt>
- <dd>Default max burst for SCTP endpoints.</dd>
- <dt id="peer_chkoh"><var class="Va">peer_chkoh</var></dt>
- <dd>Amount to debit peers rwnd per chunk sent.</dd>
- <dt id="strict_sacks"><var class="Va">strict_sacks</var></dt>
- <dd>Enable SCTP Strict SACK checking.</dd>
- <dt id="pktdrop_enable"><var class="Va">pktdrop_enable</var></dt>
- <dd>Enable SCTP PKTDROP.</dd>
- <dt id="nrsack_enable"><var class="Va">nrsack_enable</var></dt>
- <dd>Enable SCTP NR-SACK.</dd>
- <dt id="reconfig_enable"><var class="Va">reconfig_enable</var></dt>
- <dd>Enable SCTP RE-CONFIG.</dd>
- <dt id="asconf_enable"><var class="Va">asconf_enable</var></dt>
- <dd>Enable SCTP ASCONF.</dd>
- <dt id="auth_enable"><var class="Va">auth_enable</var></dt>
- <dd>Enable SCTP AUTH.</dd>
- <dt id="pr_enable"><var class="Va">pr_enable</var></dt>
- <dd>Enable PR-SCTP.</dd>
- <dt id="auto_asconf"><var class="Va">auto_asconf</var></dt>
- <dd>Enable SCTP Auto-ASCONF.</dd>
- <dt id="recvspace"><var class="Va">recvspace</var></dt>
- <dd>Maximum incoming SCTP buffer size.</dd>
- <dt id="sendspace"><var class="Va">sendspace</var></dt>
- <dd>Maximum outgoing SCTP buffer size.</dd>
- </dl>
- </dd>
-</dl>
-</section>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
- ALSO</a></h1>
-<p class="Pp"><a class="Xr">accept(2)</a>, <a class="Xr">bind(2)</a>,
- <a class="Xr">connect(2)</a>, <a class="Xr">listen(2)</a>,
- <a class="Xr">sctp_bindx(3)</a>, <a class="Xr">sctp_connectx(3)</a>,
- <a class="Xr">sctp_opt_info(3)</a>, <a class="Xr">sctp_recvmsg(3)</a>,
- <a class="Xr">sctp_sendmsg(3)</a>, <a class="Xr">blackhole(4)</a></p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1>
-<p class="Pp">The <code class="Nm">sctp</code> kernel module cannot be
- unloaded.</p>
-</section>
-</div>
-<table class="foot">
- <tr>
- <td class="foot-date">June 21, 2023</td>
- <td class="foot-os">FreeBSD 15.0</td>
- </tr>
-</table>