[sr-dev] git:master: sctp: added skeleton files for docbook module documentation
Daniel-Constantin Mierla
miconda at gmail.com
Sat May 25 17:29:07 CEST 2013
Module: sip-router
Branch: master
Commit: c4cf64ea992e0f0f46f1c6fc23c6f38c05a80b0f
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=c4cf64ea992e0f0f46f1c6fc23c6f38c05a80b0f
Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: Sat May 25 17:05:58 2013 +0200
sctp: added skeleton files for docbook module documentation
---
modules/sctp/README | 98 ++++++++++++++++++++++++++++++++++
modules/sctp/doc/Makefile | 4 ++
modules/sctp/doc/sctp.xml | 34 ++++++++++++
modules/sctp/doc/sctp_admin.xml | 110 +++++++++++++++++++++++++++++++++++++++
4 files changed, 246 insertions(+), 0 deletions(-)
diff --git a/modules/sctp/README b/modules/sctp/README
new file mode 100644
index 0000000..c6d1e02
--- /dev/null
+++ b/modules/sctp/README
@@ -0,0 +1,98 @@
+SCTP Module
+
+Daniel-Constantin Mierla
+
+ <miconda at gmail.com>
+
+Andrei Pelinescu-Onciul
+ __________________________________________________________________
+
+ Table of Contents
+
+ 1. Admin Guide
+
+ 1. Overview
+ 2. Dependencies
+
+ 2.1. Kamailio Modules
+ 2.2. External Libraries or Applications
+
+ 3. Parameters
+
+ 3.1. sctp_socket_rcvbuf (int)
+ 3.2. sctp_ (int)
+
+ List of Examples
+
+ 1.1. Set sctp_socket_rcvbuf parameter
+ 1.2. Set sctp_ parameter
+
+Chapter 1. Admin Guide
+
+ Table of Contents
+
+ 1. Overview
+ 2. Dependencies
+
+ 2.1. Kamailio Modules
+ 2.2. External Libraries or Applications
+
+ 3. Parameters
+
+ 3.1. sctp_socket_rcvbuf (int)
+ 3.2. sctp_ (int)
+
+1. Overview
+
+ This module provides SCTP transport layer for Kamailio. SCTP is an
+ acronym for Stream Control Transmission Protocol, read more about it
+ at: http://en.wikipedia.org/wiki/Stream_Control_Transmission_Protocol
+
+ The module itself implements the callbacks required by the core to
+ receive and send SIP messages over SCTP sockets.
+
+ The core Makefile variable SCTP must be set to 1 (which is by default
+ set to 1 in Makefile.defs) and sources compiled with -DUSE_SCTP
+ (automatically set when SCTP=1). In other words, if core Makefiles are
+ not changed and SCTP variable is not overwritten from command line,
+ then the SCTP support in core is enabled.
+
+2. Dependencies
+
+ 2.1. Kamailio Modules
+ 2.2. External Libraries or Applications
+
+2.1. Kamailio Modules
+
+ The following modules must be loaded before this module:
+ * none.
+
+2.2. External Libraries or Applications
+
+ The following libraries or applications must be installed before
+ running Kamailio with this module loaded:
+ * libsctp - SCTP user space library available on Linux. To compile
+ the module, libsctp-dev is required as well.
+
+3. Parameters
+
+ 3.1. sctp_socket_rcvbuf (int)
+ 3.2. sctp_ (int)
+
+3.1. sctp_socket_rcvbuf (int)
+
+ Default value is automatically set based on OS limits.
+
+ Example 1.1. Set sctp_socket_rcvbuf parameter
+...
+modparam("sctp", "sctp_socket_rcvbuf", )
+...
+
+3.2. sctp_ (int)
+
+ Default value is 1.
+
+ Example 1.2. Set sctp_ parameter
+...
+modparam("sctp", "sctp", )
+...
diff --git a/modules/sctp/doc/Makefile b/modules/sctp/doc/Makefile
new file mode 100644
index 0000000..953e62d
--- /dev/null
+++ b/modules/sctp/doc/Makefile
@@ -0,0 +1,4 @@
+docs = sctp.xml
+
+docbook_dir = ../../../docbook
+include $(docbook_dir)/Makefile.module
diff --git a/modules/sctp/doc/sctp.xml b/modules/sctp/doc/sctp.xml
new file mode 100644
index 0000000..4f03c2f
--- /dev/null
+++ b/modules/sctp/doc/sctp.xml
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+<!-- Include general documentation entities -->
+<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
+%docentities;
+
+]>
+
+<book xmlns:xi="http://www.w3.org/2001/XInclude">
+ <bookinfo>
+ <title>SCTP Module</title>
+ <productname class="trade">kamailio.org</productname>
+ <authorgroup>
+ <author>
+ <firstname>Daniel-Constantin</firstname>
+ <surname>Mierla</surname>
+ <email>miconda at gmail.com</email>
+ </author>
+ <author>
+ <firstname>Andrei</firstname>
+ <surname>Pelinescu-Onciul</surname>
+ <address>
+ <email>andrei at iptel.org</email>
+ </address>
+ </author>
+ </authorgroup>
+ </bookinfo>
+ <toc></toc>
+
+ <xi:include href="sctp_admin.xml"/>
+
+</book>
diff --git a/modules/sctp/doc/sctp_admin.xml b/modules/sctp/doc/sctp_admin.xml
new file mode 100644
index 0000000..f95bc9e
--- /dev/null
+++ b/modules/sctp/doc/sctp_admin.xml
@@ -0,0 +1,110 @@
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+<!-- Include general documentation entities -->
+<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
+%docentities;
+
+]>
+<!-- Module User's Guide -->
+
+<chapter>
+
+ <title>&adminguide;</title>
+
+ <section>
+ <title>Overview</title>
+ <para>
+ This module provides SCTP transport layer for &kamailio;. SCTP is an
+ acronym for Stream Control Transmission Protocol, read more about it
+ at: <ulink url="http://en.wikipedia.org/wiki/Stream_Control_Transmission_Protocol">
+ http://en.wikipedia.org/wiki/Stream_Control_Transmission_Protocol</ulink>
+ </para>
+ <para>
+ The module itself implements the callbacks required by the core to
+ receive and send SIP messages over SCTP sockets.
+ </para>
+ <para>
+ The core Makefile variable SCTP must be set to 1 (which is by default set
+ to 1 in Makefile.defs) and sources compiled with -DUSE_SCTP (automatically
+ set when SCTP=1). In other words, if core Makefiles are not changed and
+ SCTP variable is not overwritten from command line, then the SCTP
+ support in core is enabled.
+ </para>
+ </section>
+
+ <section>
+ <title>Dependencies</title>
+ <section>
+ <title>&kamailio; 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
+ &kamailio; with this module loaded:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>libsctp</emphasis> - SCTP user space library available
+ on Linux. To compile the module, libsctp-dev is required as well.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+ </section>
+ <section>
+ <title>Parameters</title>
+ <section id="sctp.p.sctp_socket_rcvbuf">
+ <title><varname>sctp_socket_rcvbuf</varname> (int)</title>
+ <para>
+ </para>
+ <para>
+ <emphasis>
+ Default value is automatically set based on OS limits.
+ </emphasis>
+ </para>
+ <example>
+ <title>Set <varname>sctp_socket_rcvbuf</varname> parameter</title>
+ <programlisting format="linespecific">
+...
+modparam("sctp", "sctp_socket_rcvbuf", )
+...
+</programlisting>
+ </example>
+ </section>
+
+ <section id="sctp.p.">
+ <title><varname>sctp_</varname> (int)</title>
+ <para>
+ </para>
+ <para>
+ <emphasis>
+ Default value is 1.
+ </emphasis>
+ </para>
+ <example>
+ <title>Set <varname>sctp_</varname> parameter</title>
+ <programlisting format="linespecific">
+...
+modparam("sctp", "sctp", )
+...
+</programlisting>
+ </example>
+ </section>
+ </section>
+
+</chapter>
+
More information about the sr-dev
mailing list