Browse Source

cnxcc: added section ids in the docs

Daniel-Constantin Mierla 8 years ago
parent
commit
f5430eb0ad
1 changed files with 36 additions and 37 deletions
  1. 36 37
      src/modules/cnxcc/doc/cnxcc_admin.xml

+ 36 - 37
src/modules/cnxcc/doc/cnxcc_admin.xml

@@ -17,7 +17,7 @@
 	<para>
 	<para>
 		This module was designed to act as a mechanism to limit call duration based on credit information parameters.
 		This module was designed to act as a mechanism to limit call duration based on credit information parameters.
 		After getting the credit information of the call being set up, you can instruct the module to start monitoring
 		After getting the credit information of the call being set up, you can instruct the module to start monitoring
-		the consumed credit to shutdown a single call or a group of calls in case of credit exhaustion.	
+		the consumed credit to shutdown a single call or a group of calls in case of credit exhaustion.
 	</para>
 	</para>
 	<para>
 	<para>
 		Every call is associated to an unique client/customer identifier. If a credit event occurs, all calls hooked
 		Every call is associated to an unique client/customer identifier. If a credit event occurs, all calls hooked
@@ -49,7 +49,7 @@
 	<section>
 	<section>
 	    <title>Modules</title>
 	    <title>Modules</title>
 	    <para>
 	    <para>
-		The following module must be loaded before this module: 
+		The following module must be loaded before this module:
 		<itemizedlist>
 		<itemizedlist>
 		    <listitem>
 		    <listitem>
 		    <para>
 		    <para>
@@ -62,7 +62,7 @@
 	<section>
 	<section>
 	    <title>Libraries</title>
 	    <title>Libraries</title>
 	    <para>
 	    <para>
-		The following module must be loaded before this module: 
+		The following module must be loaded before this module:
 		<itemizedlist>
 		<itemizedlist>
 		    <listitem>
 		    <listitem>
 		    <para>
 		    <para>
@@ -83,23 +83,22 @@
 
 
     <section>
     <section>
 	<title>Parameters</title>
 	<title>Parameters</title>
-	<section>
-		<title><varname> redis </varname> (integer)</title>
+	<section id="cnxcc.p.redis">
+		<title><varname>redis</varname> (integer)</title>
 	    <para>
 	    <para>
 		Redis datasource connection information
 		Redis datasource connection information
 	    </para>
 	    </para>
 	    <example>
 	    <example>
 
 
-		<title>dlg_flag</title>
 		<programlisting format="linespecific">
 		<programlisting format="linespecific">
 ...
 ...
 modparam("cnxcc", "redis", "addr=127.0.0.1;port=6379;db=1")
 modparam("cnxcc", "redis", "addr=127.0.0.1;port=6379;db=1")
-...		
+...
 		</programlisting>
 		</programlisting>
 	    </example>
 	    </example>
 	</section>
 	</section>
 
 
-	<section>
+	<section id="cnxcc.p.credit_check_period">
 	    <title><varname>credit_check_period</varname> (integer)</title>
 	    <title><varname>credit_check_period</varname> (integer)</title>
 	    <para>
 	    <para>
 		Indicates how often the credit checking function should be called. It is directly related to the precison of the
 		Indicates how often the credit checking function should be called. It is directly related to the precison of the
@@ -114,15 +113,15 @@ modparam("cnxcc", "redis", "addr=127.0.0.1;port=6379;db=1")
 		<programlisting format="linespecific">
 		<programlisting format="linespecific">
 ...
 ...
 modparam("cnxcc", "credit_check_period", 1)
 modparam("cnxcc", "credit_check_period", 1)
-...		
+...
 		</programlisting>
 		</programlisting>
 	    </example>
 	    </example>
-	</section> 
+	</section>
    </section>
    </section>
 
 
     <section>
     <section>
 	<title>Functions</title>
 	<title>Functions</title>
-	<section>
+	<section id="cnxcc.f.set_max_credit">
 	    <title>
 	    <title>
 		<function moreinfo="none">cnxcc_set_max_credit()</function>
 		<function moreinfo="none">cnxcc_set_max_credit()</function>
 	    </title>
 	    </title>
@@ -164,12 +163,12 @@ $var(initial_p)   = "030";    # intial pulse
 $var(final_p)   = "006";      # final pulse
 $var(final_p)   = "006";      # final pulse
 
 
 cnxcc_set_max_credit("$var(customer)", "$var(credit)", "$var(cps)", "$var(initial_p)", "$var(final_p)");
 cnxcc_set_max_credit("$var(customer)", "$var(credit)", "$var(cps)", "$var(initial_p)", "$var(final_p)");
-...		
+...
 		</programlisting>
 		</programlisting>
 	    </example>
 	    </example>
 	</section>
 	</section>
 
 
-        <section>
+        <section id="cnxcc.f.set_max_time">
             <title>
             <title>
                 <function moreinfo="none">cnxcc_set_max_time()</function>
                 <function moreinfo="none">cnxcc_set_max_time()</function>
             </title>
             </title>
@@ -184,7 +183,7 @@ cnxcc_set_max_credit("$var(customer)", "$var(credit)", "$var(cps)", "$var(initia
                         <emphasis>1 - successful</emphasis>
                         <emphasis>1 - successful</emphasis>
                     </para>
                     </para>
                     </listitem>
                     </listitem>
-                     
+
                     <listitem>
                     <listitem>
                     <para>
                     <para>
                         <emphasis>-1 - failed, error logged</emphasis>
                         <emphasis>-1 - failed, error logged</emphasis>
@@ -205,7 +204,7 @@ cnxcc_set_max_time("$var(customer)", "$var(max_time)");
             </example>
             </example>
         </section>
         </section>
 
 
-        <section>
+        <section id="cnxcc.f.update_max_time">
             <title>
             <title>
                 <function moreinfo="none">cnxcc_update_max_time()</function>
                 <function moreinfo="none">cnxcc_update_max_time()</function>
             </title>
             </title>
@@ -220,7 +219,7 @@ cnxcc_set_max_time("$var(customer)", "$var(max_time)");
                         <emphasis>1 - successful</emphasis>
                         <emphasis>1 - successful</emphasis>
                     </para>
                     </para>
                     </listitem>
                     </listitem>
-                     
+
                     <listitem>
                     <listitem>
                     <para>
                     <para>
                         <emphasis>-1 - failed, error logged</emphasis>
                         <emphasis>-1 - failed, error logged</emphasis>
@@ -248,7 +247,7 @@ cnxcc_set_max_time("$var(customer)", "$var(max_time)");
 
 
 
 
 
 
-    	<section>
+    	<section id="cnxcc.f.set_max_channel">
             <title>
             <title>
                 <function moreinfo="none">cnxcc_set_max_channel()</function>
                 <function moreinfo="none">cnxcc_set_max_channel()</function>
             </title>
             </title>
@@ -263,7 +262,7 @@ cnxcc_set_max_time("$var(customer)", "$var(max_time)");
                         <emphasis>1 - successful</emphasis>
                         <emphasis>1 - successful</emphasis>
                     </para>
                     </para>
                     </listitem>
                     </listitem>
-                     
+
                     <listitem>
                     <listitem>
                     <para>
                     <para>
                         <emphasis>-1 - failed, error logged</emphasis>
                         <emphasis>-1 - failed, error logged</emphasis>
@@ -275,7 +274,7 @@ cnxcc_set_max_time("$var(customer)", "$var(max_time)");
                         <emphasis>-2 - failed, calls established plus calls being established result in more than the limit you specified</emphasis>
                         <emphasis>-2 - failed, calls established plus calls being established result in more than the limit you specified</emphasis>
                     </para>
                     </para>
                     </listitem>
                     </listitem>
-		    
+
 		    <listitem>
 		    <listitem>
                     <para>
                     <para>
                         <emphasis>-3 - failed, number of calls established is more than the limit you specified</emphasis>
                         <emphasis>-3 - failed, number of calls established is more than the limit you specified</emphasis>
@@ -312,8 +311,8 @@ if ($var(retcode) &lt; -1) {
 		</programlisting>
 		</programlisting>
             </example>
             </example>
     	</section>
     	</section>
-	
-    	<section>
+
+    	<section id="cnxcc.f.terminate_all">
             <title>
             <title>
                 <function moreinfo="none">cnxcc_terminate_all()</function>
                 <function moreinfo="none">cnxcc_terminate_all()</function>
             </title>
             </title>
@@ -328,7 +327,7 @@ if ($var(retcode) &lt; -1) {
                         <emphasis>1 - successful</emphasis>
                         <emphasis>1 - successful</emphasis>
                     </para>
                     </para>
                     </listitem>
                     </listitem>
-                     
+
                     <listitem>
                     <listitem>
                     <para>
                     <para>
                         <emphasis>-1 - failed, error logged</emphasis>
                         <emphasis>-1 - failed, error logged</emphasis>
@@ -350,12 +349,12 @@ if (!cnxcc_terminate_all("$var(customer)")) {
             </example>
             </example>
         </section>
         </section>
     </section>
     </section>
-   
+
     <section>
     <section>
 	<title>RPC Commands</title>
 	<title>RPC Commands</title>
 
 
-	<section>
-	    <title><varname>cnxcc.active_clients</varname></title>
+	<section id="cnxcc.rpc.active_clients">
+	    <title>cnxcc.active_clients</title>
 	    <para>
 	    <para>
 		Retrieves all calls grouped by their identifiers.
 		Retrieves all calls grouped by their identifiers.
 	    </para>
 	    </para>
@@ -370,8 +369,8 @@ if (!cnxcc_terminate_all("$var(customer)")) {
 	    </programlisting>
 	    </programlisting>
 	</section>
 	</section>
 
 
-	<section>
-            <title><varname>cnxcc.check_client</varname></title>
+	<section id="cnxcc.rpc.check_client">
+            <title>cnxcc.check_client</title>
             <para>
             <para>
 		Retrives all calls from a particular identifier.
 		Retrives all calls from a particular identifier.
             </para>
             </para>
@@ -386,8 +385,8 @@ if (!cnxcc_terminate_all("$var(customer)")) {
             </programlisting>
             </programlisting>
         </section>
         </section>
 
 
-        <section>
-            <title><varname>cnxcc.kill_call</varname></title>
+        <section id="cnxcc.rpc.kill_call">
+            <title>cnxcc.kill_call</title>
             <para>
             <para>
 		    Kills an active call using its call ID.
 		    Kills an active call using its call ID.
 	    </para>
 	    </para>
@@ -401,8 +400,8 @@ if (!cnxcc_terminate_all("$var(customer)")) {
             &sercmd; cnxcc.kill_call [email protected]
             &sercmd; cnxcc.kill_call [email protected]
             </programlisting>
             </programlisting>
         </section>
         </section>
-	<section>
-	    <title><varname>cnxcc.stats</varname></title>
+	<section id="cnxcc.rpc.stats">
+	    <title>cnxcc.stats</title>
 	    <para>
 	    <para>
 		List credit control stats.
 		List credit control stats.
 	    </para>
 	    </para>
@@ -419,9 +418,9 @@ if (!cnxcc_terminate_all("$var(customer)")) {
 
 
     </section>
     </section>
 
 
-    <section>
+    <section id="cnxcc.evr.callshutdown">
 	    <title>Events</title>
 	    <title>Events</title>
-	    
+
 	    <para>
 	    <para>
 		When a call is forced to end an event route is automatically invoked. This route is suited with a fake OPTIONS
 		When a call is forced to end an event route is automatically invoked. This route is suited with a fake OPTIONS
 		message containing the call ID, ftag and ttag of the original call so it can be located somehow in the accounting
 		message containing the call ID, ftag and ttag of the original call so it can be located somehow in the accounting
@@ -440,14 +439,14 @@ event_route[cnxcc:call-shutdown]
 }
 }
 ...
 ...
 		</programlisting>
 		</programlisting>
-	    
+
     </section>
     </section>
     <section>
     <section>
             <title>Web Interface</title>
             <title>Web Interface</title>
 
 
             <para>
             <para>
 		The module contains a web management interface completely optional. With it, you can review your calls in real time
 		The module contains a web management interface completely optional. With it, you can review your calls in real time
-		and hang them up if necessary.    
+		and hang them up if necessary.
 	    </para>
 	    </para>
             <para>
             <para>
                 Link: https://github.com/caruizdiaz/cnxcc-web
                 Link: https://github.com/caruizdiaz/cnxcc-web
@@ -455,7 +454,7 @@ event_route[cnxcc:call-shutdown]
     </section>
     </section>
 
 
     <section>
     <section>
-	<title>Sample</title>
+	<title>Sample Config</title>
 	<example>
 	<example>
 	    <title>kamailio-cnxcc.cfg</title>
 	    <title>kamailio-cnxcc.cfg</title>
 	    <programlisting format="linespecific">
 	    <programlisting format="linespecific">
@@ -482,7 +481,7 @@ event_route[cnxcc:call-shutdown]
 	xlog("L_INFO", "[$ci]: call killed");
 	xlog("L_INFO", "[$ci]: call killed");
 
 
 
 
-}	    
+}
 ...
 ...
 	    </programlisting>
 	    </programlisting>
 	</example>
 	</example>