Pārlūkot izejas kodu

sctp: added rpc commands to module documentation

Daniel-Constantin Mierla 12 gadi atpakaļ
vecāks
revīzija
375d878b5f
2 mainītis faili ar 69 papildinājumiem un 0 dzēšanām
  1. 36 0
      modules/sctp/README
  2. 33 0
      modules/sctp/doc/sctp_admin.xml

+ 36 - 0
modules/sctp/README

@@ -39,6 +39,11 @@ Andrei Pelinescu-Onciul
               3.18. sctp_sack_freq (int)
               3.18. sctp_sack_freq (int)
               3.19. sctp_max_burst (int)
               3.19. sctp_max_burst (int)
 
 
+        4. RPC Commands
+
+              4.1. sctp.info
+              4.2. sctp.options
+
    List of Examples
    List of Examples
 
 
    1.1. Set sctp_socket_rcvbuf parameter
    1.1. Set sctp_socket_rcvbuf parameter
@@ -60,6 +65,8 @@ Andrei Pelinescu-Onciul
    1.17. Set sctp_sack_delay parameter
    1.17. Set sctp_sack_delay parameter
    1.18. Set sctp_sack_freq parameter
    1.18. Set sctp_sack_freq parameter
    1.19. Set sctp_max_burst 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
 Chapter 1. Admin Guide
 
 
@@ -93,6 +100,11 @@ Chapter 1. Admin Guide
         3.18. sctp_sack_freq (int)
         3.18. sctp_sack_freq (int)
         3.19. sctp_max_burst (int)
         3.19. sctp_max_burst (int)
 
 
+   4. RPC Commands
+
+        4.1. sctp.info
+        4.2. sctp.options
+
 1. Overview
 1. Overview
 
 
    This module provides SCTP transport layer for Kamailio. SCTP is an
    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)
 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
+...

+ 33 - 0
modules/sctp/doc/sctp_admin.xml

@@ -580,6 +580,39 @@ modparam("sctp", "sctp_sack_freq", 3)
 ...
 ...
 modparam("sctp", "sctp_max_burst", 3)
 modparam("sctp", "sctp_max_burst", 3)
 ...
 ...
+</programlisting>
+		</example>
+	</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>
 </programlisting>
 		</example>
 		</example>
 	</section>
 	</section>