<!-- Module User's Guide -->

<chapter>

	<title>&adminguide;</title>

	<section id="overview" xreflabel="Overview">
	<title>Overview</title>
	<para>
	The <emphasis role='bold'>proto_sctp</emphasis> module is an optional transport module (shared library) which
	exports the required logic in order to handle SCTP-based communication. (socket initialization
	and send/recv primitives to be used by higher-level network layers)
	</para>
	<para>
	Once loaded, you will be able to define <emphasis>"sctp:"</emphasis> listeners in your script.
	</para>
	</section>

	<section id="dependencies" xreflabel="Dependencies">
	<title>Dependencies</title>
	<section>
		<title>&osips; Modules</title>
		<para>
		The following modules must be loaded before this module:
			<itemizedlist>
			<listitem>
			<para>
				<emphasis>None</emphasis>.
			</para>
			</listitem>
			</itemizedlist>
		</para>
	</section>

	<section>
		<title>External Libraries or Applications</title>
		<para>
		The following libraries or applications must be installed before
		running &osips; with this module loaded:
			<itemizedlist>
			<listitem>
			<para>
				<emphasis>None</emphasis>.
			</para>
			</listitem>
			</itemizedlist>
		</para>
	</section>
	</section>

	<section id="exported_parameters" xreflabel="Exported Parameters">
	<title>Exported Parameters</title>
	<section id="param_sctp_port" xreflabel="sctp_port">
		<title><varname>sctp_port</varname> (integer)</title>
		<para>
		The default port to be used for all SCTP related operation. Be careful
		as the default port impacts both the SIP listening part (if no port is
		defined in the SCTP listeners) and the SIP sending part (if the 
		destination SCTP URI has no explicit port).
		</para>
		<para>
		If you want to change only the listening port for STP, use the port
		option in the SIP listener defintion.
		</para>
		<para>
		<emphasis>
			Default value is 5060.
		</emphasis>
		</para>
		<example>
		<title>Set <varname>sctp_port</varname> parameter</title>
		<programlisting format="linespecific">
...
modparam("proto_sctp", "sctp_port", 5070)
...
</programlisting>
		</example>
	</section>
	</section>

</chapter>
