[sr-dev] git:master: sctp: added rpc commands to module documentation

Daniel-Constantin Mierla miconda at gmail.com
Sun May 26 17:18:57 CEST 2013


Module: sip-router
Branch: master
Commit: 375d878b5f318acc08b155c29398e4abb74edbd5
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=375d878b5f318acc08b155c29398e4abb74edbd5

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Sun May 26 17:11:25 2013 +0200

sctp: added rpc commands to module documentation

---

 modules/sctp/README             |   36 ++++++++++++++++++++++++++++++++++++
 modules/sctp/doc/sctp_admin.xml |   33 +++++++++++++++++++++++++++++++++
 2 files changed, 69 insertions(+), 0 deletions(-)

diff --git a/modules/sctp/README b/modules/sctp/README
index e05854e..1fb71dc 100644
--- a/modules/sctp/README
+++ b/modules/sctp/README
@@ -39,6 +39,11 @@ Andrei Pelinescu-Onciul
               3.18. sctp_sack_freq (int)
               3.19. sctp_max_burst (int)
 
+        4. RPC Commands
+
+              4.1. sctp.info
+              4.2. sctp.options
+
    List of Examples
 
    1.1. Set sctp_socket_rcvbuf parameter
@@ -60,6 +65,8 @@ Andrei Pelinescu-Onciul
    1.17. Set sctp_sack_delay parameter
    1.18. Set sctp_sack_freq parameter
    1.19. Set sctp_max_burst parameter
+   1.20. Use sctp.info with kamcmd
+   1.21. Use sctp.options with kamcmd
 
 Chapter 1. Admin Guide
 
@@ -93,6 +100,11 @@ Chapter 1. Admin Guide
         3.18. sctp_sack_freq (int)
         3.19. sctp_max_burst (int)
 
+   4. RPC Commands
+
+        4.1. sctp.info
+        4.2. sctp.options
+
 1. Overview
 
    This module provides SCTP transport layer for Kamailio. SCTP is an
@@ -464,3 +476,27 @@ modparam("sctp", "sctp_sack_freq", 3)
 ...
 modparam("sctp", "sctp_max_burst", 3)
 ...
+
+4. RPC Commands
+
+   4.1. sctp.info
+   4.2. sctp.options
+
+4.1. sctp.info
+
+   Print information about SCTP transport.
+
+   Example 1.20. Use sctp.info with kamcmd
+...
+kamcmd sctp.info
+...
+
+4.2. sctp.options
+
+   Print the options of SCTP sockets. It can take an optional parameter
+   that specifies the listen address of SCTP socket.
+
+   Example 1.21. Use sctp.options with kamcmd
+...
+kamcmd sctp.options
+...
diff --git a/modules/sctp/doc/sctp_admin.xml b/modules/sctp/doc/sctp_admin.xml
index 2009fcb..3ede4ca 100644
--- a/modules/sctp/doc/sctp_admin.xml
+++ b/modules/sctp/doc/sctp_admin.xml
@@ -585,5 +585,38 @@ modparam("sctp", "sctp_max_burst", 3)
 	</section>
 	</section>
 
+	<section>
+	<title>RPC Commands</title>
+	<section id="sctp.r.sctp.info">
+		<title><varname>sctp.info</varname></title>
+		<para>
+			Print information about SCTP transport.
+		</para>
+		<example>
+		<title>Use <varname>sctp.info</varname> with kamcmd</title>
+		<programlisting format="linespecific">
+...
+kamcmd sctp.info
+...
+</programlisting>
+		</example>
+	</section>
+	<section id="sctp.r.sctp.">
+		<title><varname>sctp.options</varname></title>
+		<para>
+			Print the options of SCTP sockets. It can take an optional
+			parameter that specifies the listen address of SCTP socket.
+		</para>
+		<example>
+		<title>Use <varname>sctp.options</varname> with kamcmd</title>
+		<programlisting format="linespecific">
+...
+kamcmd sctp.options
+...
+</programlisting>
+		</example>
+	</section>
+	</section>
+
 </chapter>
 




More information about the sr-dev mailing list