doc/rpc_list: regenerated rpc commands lists
authorDaniel-Constantin Mierla <miconda@gmail.com>
Tue, 14 Oct 2014 12:46:30 +0000 (14:46 +0200)
committerDaniel-Constantin Mierla <miconda@gmail.com>
Tue, 14 Oct 2014 12:46:30 +0000 (14:46 +0200)
24 files changed:
doc/rpc_list/Makefile
doc/rpc_list/docbook/rpc_app_perl.xml [new file with mode: 0644]
doc/rpc_list/docbook/rpc_cdp.xml [new file with mode: 0644]
doc/rpc_list/docbook/rpc_core.xml
doc/rpc_list/docbook/rpc_corex.xml
doc/rpc_list/docbook/rpc_dialog.xml
doc/rpc_list/docbook/rpc_dmq.xml [new file with mode: 0644]
doc/rpc_list/docbook/rpc_htable.xml
doc/rpc_list/docbook/rpc_jsonrpc-s.xml [new file with mode: 0644]
doc/rpc_list/docbook/rpc_kex.xml
doc/rpc_list/docbook/rpc_list.xml
doc/rpc_list/docbook/rpc_mtree.xml
doc/rpc_list/docbook/rpc_uac.xml
doc/rpc_list/rpc_app_perl.txt [new file with mode: 0644]
doc/rpc_list/rpc_cdp.txt [new file with mode: 0644]
doc/rpc_list/rpc_core.txt
doc/rpc_list/rpc_corex.txt
doc/rpc_list/rpc_dialog.txt
doc/rpc_list/rpc_dmq.txt [new file with mode: 0644]
doc/rpc_list/rpc_htable.txt
doc/rpc_list/rpc_jsonrpc-s.txt [new file with mode: 0644]
doc/rpc_list/rpc_kex.txt
doc/rpc_list/rpc_mtree.txt
doc/rpc_list/rpc_uac.txt

index 69a9ba5..5c6c5ab 100644 (file)
@@ -23,7 +23,9 @@ docbook_output_dir=docbook
 files_list= \
                        $(COREPATH)/core_cmd.c:core \
                        $(COREPATH)/modules/app_lua/app_lua_mod.c:app_lua \
+                       $(COREPATH)/modules/app_perl/app_perl_mod.c:app_perl \
                        $(COREPATH)/modules/carrierroute/carrierroute.c:carrierroute \
+                       $(COREPATH)/modules/cdp/cdp_rpc.c:cdp \
                        $(COREPATH)/modules/cfg_rpc/cfg_rpc.c:cfg_rpc \
                        $(COREPATH)/modules/cnxcc/cnxcc_mod.c:cnxcc \
                        $(COREPATH)/modules/corex/corex_rpc.c:corex \
@@ -37,11 +39,14 @@ files_list= \
                        $(COREPATH)/modules/dialog_ng/dialog.c:dialog_ng \
                        $(COREPATH)/modules/dialplan/dialplan.c:dialplan \
                        $(COREPATH)/modules/dispatcher/dispatcher.c:dispatcher \
+                       $(COREPATH)/modules/dmq/dmq.c:dmq \
                        $(COREPATH)/modules/domain/domain_mod.c:domain \
                        $(COREPATH)/modules/drouting/drouting.c:drouting \
                        $(COREPATH)/modules/htable/htable.c:htable \
                        $(COREPATH)/modules/ims_usrloc_pcscf/ul_rpc.c:ims_usrloc_pcscf \
                        $(COREPATH)/modules/ims_usrloc_scscf/ul_rpc.c:ims_usrloc_scscf \
+                       $(COREPATH)/modules/jsonrpc-s/jsonrpc-s_mod.c:jsonrpc-s \
+                       $(COREPATH)/modules/kex/core_stats.c:kex \
                        $(COREPATH)/modules/kex/pkg_stats.c:kex \
                        $(COREPATH)/modules/lcr/lcr_rpc.c:lcr \
                        $(COREPATH)/modules/malloc_test/malloc_test.c:malloc_test \
@@ -100,17 +105,19 @@ gcc=gcc
 # defines used by gcc
 # -D__CPU_i386 -DARCH="i386"
 c_defsX= -D__CPU_x86_64 -D__OS_linux -DSER_VER=3003000 -DPKG_MALLOC -DSHM_MEM  \
-               -DVERSION='\"3.3.0-dev2\"' -DARCH='\"x86_64\"' -DOS=linux_ -DOS_QUOTED='\"linux\"' \
+               -DVERSION='\"4.3.0\"' -DARCH='\"x86_64\"' -DOS=linux_ -DOS_QUOTED='\"linux\"' \
                -DSHM_MMAP -DDNS_IP_HACK -DUSE_MCAST -DUSE_TCP \
                -DUSE_DNS_CACHE -DUSE_DNS_FAILOVER -DUSE_DST_BLACKLIST -DUSE_NAPTR \
                -DUSE_TLS -DTLS_HOOKS -DFAST_LOCK   -DCC_GCC_LIKE_ASM \
                -DHAVE_GETHOSTBYNAME2 -DHAVE_UNION_SEMUN -DHAVE_SCHED_YIELD \
                -DHAVE_MSG_NOSIGNAL -DHAVE_MSGHDR_MSG_CONTROL -DHAVE_ALLOCA_H \
-               -DHAVE_SCHED_SETSCHEDULER -DHAVE_EPOLL -DUSE_SCTP -DNAME='\"ser\"' \
-               -DCFG_DIR='\"/tmp/\"'
+               -DHAVE_SCHED_SETSCHEDULER -DHAVE_EPOLL -DUSE_SCTP -DNAME='\"kamailio\"' \
+               -DMOD_NAME='\"rpcmod\"' -DCFG_DIR='\"/tmp/\"'
 
 c_defs=$(subst ^^,='\",$(subst ",\"',$(subst =",^^,$(shell make -s -C ../.. printcdefs))))
 
+c_defs+= -DMOD_NAME='\"rpcgen\"'
+
 # common makefile vars used in defs
 LOCALBASE=/usr/local
 SYSBASE=/usr
diff --git a/doc/rpc_list/docbook/rpc_app_perl.xml b/doc/rpc_list/docbook/rpc_app_perl.xml
new file mode 100644 (file)
index 0000000..72dc53e
--- /dev/null
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- this file is autogenerated, do not edit! -->
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+       "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<chapter id="rpc_exports.app_perl">
+       <title>
+RPC Exports for app_perl
+       </title>
+
+
+<section id="app_perl.set_reset_cycles"><title>app_perl.set_reset_cycles</title>
+<para>
+        Set the value for reset_cycles
+</para>
+<para>
+</para>
+</section>
+
+<section id="app_perl.get_reset_cycles"><title>app_perl.get_reset_cycles</title>
+<para>
+        Get the value for reset_cycles
+</para>
+<para>
+</para>
+</section>
+
+</chapter>
diff --git a/doc/rpc_list/docbook/rpc_cdp.xml b/doc/rpc_list/docbook/rpc_cdp.xml
new file mode 100644 (file)
index 0000000..d21679a
--- /dev/null
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- this file is autogenerated, do not edit! -->
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+       "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<chapter id="rpc_exports.cdp">
+       <title>
+RPC Exports for cdp
+       </title>
+
+
+<section id="cdp.disable_peer"><title>cdp.disable_peer</title>
+<para>
+        disable diameter peer
+</para>
+<para>
+</para>
+</section>
+
+<section id="cdp.enable_peer"><title>cdp.enable_peer</title>
+<para>
+        enable diameter peer
+</para>
+<para>
+</para>
+</section>
+
+<section id="cdp.list_peers"><title>cdp.list_peers</title>
+<para>
+        list diameter peers and their state
+</para>
+<para>
+</para>
+</section>
+
+</chapter>
index 851d770..c6d1b84 100644 (file)
@@ -107,6 +107,7 @@ RPC Exports for core
         Returns the detailed description of running SER processes.
 </para>
 <para>
+        Returns an array.
 </para>
 </section>
 
index fcc4f48..548643c 100644 (file)
@@ -13,6 +13,7 @@ RPC Exports for corex
         List listening sockets
 </para>
 <para>
+        Returns an array.
 </para>
 </section>
 
@@ -20,6 +21,23 @@ RPC Exports for corex
 <para>
         List socket aliases
 </para>
+<para>
+        Returns an array.
+</para>
+</section>
+
+<section id="corex.shm_status"><title>corex.shm_status</title>
+<para>
+        Trigger shm status dump to syslog
+</para>
+<para>
+</para>
+</section>
+
+<section id="corex.shm_summary"><title>corex.shm_summary</title>
+<para>
+        Trigger shm summary dump to syslog
+</para>
 <para>
 </para>
 </section>
index fb876ab..47632ae 100644 (file)
@@ -13,6 +13,7 @@ RPC Exports for dialog
         Print all dialogs
 </para>
 <para>
+        Returns an array.
 </para>
 </section>
 
@@ -21,6 +22,7 @@ RPC Exports for dialog
         Print all dialogs with associated context
 </para>
 <para>
+        Returns an array.
 </para>
 </section>
 
@@ -62,6 +64,7 @@ RPC Exports for dialog
         Lists all the dialogs belonging to a profile
 </para>
 <para>
+        Returns an array.
 </para>
 </section>
 
diff --git a/doc/rpc_list/docbook/rpc_dmq.xml b/doc/rpc_list/docbook/rpc_dmq.xml
new file mode 100644 (file)
index 0000000..9de4f93
--- /dev/null
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- this file is autogenerated, do not edit! -->
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+       "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<chapter id="rpc_exports.dmq">
+       <title>
+RPC Exports for dmq
+       </title>
+
+
+<section id="dmq.list_nodes"><title>dmq.list_nodes</title>
+<para>
+        Print all nodes
+</para>
+<para>
+        Returns an array.
+</para>
+</section>
+
+</chapter>
index 84d02c6..a7917e5 100644 (file)
@@ -13,6 +13,7 @@ RPC Exports for htable
         Dump the contents of hash table.
 </para>
 <para>
+        Returns an array.
 </para>
 </section>
 
@@ -53,6 +54,7 @@ RPC Exports for htable
         List all htables.
 </para>
 <para>
+        Returns an array.
 </para>
 </section>
 
@@ -69,6 +71,7 @@ RPC Exports for htable
         Statistics about htables.
 </para>
 <para>
+        Returns an array.
 </para>
 </section>
 
diff --git a/doc/rpc_list/docbook/rpc_jsonrpc-s.xml b/doc/rpc_list/docbook/rpc_jsonrpc-s.xml
new file mode 100644 (file)
index 0000000..f3c66c8
--- /dev/null
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- this file is autogenerated, do not edit! -->
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+       "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<chapter id="rpc_exports.jsonrpc-s">
+       <title>
+RPC Exports for jsonrpc-s
+       </title>
+
+
+<section id="jsonrpc.echo"><title>jsonrpc.echo</title>
+<para>
+        Sample echo command
+</para>
+<para>
+        Returns an array.
+</para>
+</section>
+
+</chapter>
index 070f037..35c9fbc 100644 (file)
@@ -13,6 +13,7 @@ RPC Exports for kex
         Private memory (pkg) statistics per process
 </para>
 <para>
+        Returns an array.
 </para>
 </section>
 
index ad06aab..8b08c35 100644 (file)
@@ -8,8 +8,8 @@
 <book id="rpc_list" xmlns:xi="http://www.w3.org/2001/XInclude">
        <title>RPC Exports List</title>
        <bookinfo><revhistory><revision>
-               <revnumber>sip-router git-99c4af</revnumber>
-               <date>Wed, 04 Dec 2013 14:45:52 +0100</date>
+               <revnumber>sip-router git-c21808</revnumber>
+               <date>Tue, 14 Oct 2014 14:24:16 +0200</date>
                <revremark>
                        Automatically generated by:
                        make -C doc/rpc_list all
@@ -17,7 +17,9 @@
        </revision></revhistory></bookinfo>
                <xi:include href="rpc_core.xml"/>
                <xi:include href="rpc_app_lua.xml"/>
+               <xi:include href="rpc_app_perl.xml"/>
                <xi:include href="rpc_carrierroute.xml"/>
+               <xi:include href="rpc_cdp.xml"/>
                <xi:include href="rpc_cfg_rpc.xml"/>
                <xi:include href="rpc_cnxcc.xml"/>
                <xi:include href="rpc_corex.xml"/>
                <xi:include href="rpc_dialog_ng.xml"/>
                <xi:include href="rpc_dialplan.xml"/>
                <xi:include href="rpc_dispatcher.xml"/>
+               <xi:include href="rpc_dmq.xml"/>
                <xi:include href="rpc_domain.xml"/>
                <xi:include href="rpc_drouting.xml"/>
                <xi:include href="rpc_htable.xml"/>
                <xi:include href="rpc_ims_usrloc_pcscf.xml"/>
                <xi:include href="rpc_ims_usrloc_scscf.xml"/>
+               <xi:include href="rpc_jsonrpc-s.xml"/>
+               <xi:include href="rpc_kex.xml"/>
                <xi:include href="rpc_kex.xml"/>
                <xi:include href="rpc_lcr.xml"/>
                <xi:include href="rpc_malloc_test.xml"/>
index c9026e9..1cf93a7 100644 (file)
@@ -13,6 +13,7 @@ RPC Exports for mtree
         Print summary of loaded mtree tables
 </para>
 <para>
+        Returns an array.
 </para>
 </section>
 
@@ -24,4 +25,12 @@ RPC Exports for mtree
 </para>
 </section>
 
+<section id="mtree.match"><title>mtree.match</title>
+<para>
+        Match prefix value against mtree
+</para>
+<para>
+</para>
+</section>
+
 </chapter>
index cfc52a6..080c1fd 100644 (file)
@@ -16,4 +16,44 @@ RPC Exports for uac
 </para>
 </section>
 
+<section id="uac.reg_info"><title>uac.reg_info</title>
+<para>
+        Return the details of registration for a particular record.
+</para>
+<para>
+</para>
+</section>
+
+<section id="uac.reg_enable"><title>uac.reg_enable</title>
+<para>
+        Enable registration for a particular record.
+</para>
+<para>
+</para>
+</section>
+
+<section id="uac.reg_disable"><title>uac.reg_disable</title>
+<para>
+        Disable registration for a particular record.
+</para>
+<para>
+</para>
+</section>
+
+<section id="uac.reg_reload"><title>uac.reg_reload</title>
+<para>
+        Reload records from database.
+</para>
+<para>
+</para>
+</section>
+
+<section id="uac.reg_refresh"><title>uac.reg_refresh</title>
+<para>
+        Refresh a record from database.
+</para>
+<para>
+</para>
+</section>
+
 </chapter>
diff --git a/doc/rpc_list/rpc_app_perl.txt b/doc/rpc_list/rpc_app_perl.txt
new file mode 100644 (file)
index 0000000..bec2c8c
--- /dev/null
@@ -0,0 +1,12 @@
+RPC Exports for app_perl
+========================
+
+                  [ this file is autogenerated, do not edit ]
+
+
+ 1. app_perl.set_reset_cycles
+        Set the value for reset_cycles
+
+ 2. app_perl.get_reset_cycles
+        Get the value for reset_cycles
+
diff --git a/doc/rpc_list/rpc_cdp.txt b/doc/rpc_list/rpc_cdp.txt
new file mode 100644 (file)
index 0000000..6087702
--- /dev/null
@@ -0,0 +1,15 @@
+RPC Exports for cdp
+===================
+
+                  [ this file is autogenerated, do not edit ]
+
+
+ 1. cdp.disable_peer
+        disable diameter peer
+
+ 2. cdp.enable_peer
+        enable diameter peer
+
+ 3. cdp.list_peers
+        list diameter peers and their state
+
index 97369a5..988d31b 100644 (file)
@@ -45,6 +45,7 @@ RPC Exports for core
 
 12. core.psx
         Returns the detailed description of running SER processes.
+        Returns an array.
 
 13. core.pwd
         Returns the working directory of SER server.
index db5125c..84a1f6e 100644 (file)
@@ -6,7 +6,15 @@ RPC Exports for corex
 
  1. corex.list_sockets
         List listening sockets
+        Returns an array.
 
  2. corex.list_aliases
         List socket aliases
+        Returns an array.
+
+ 3. corex.shm_status
+        Trigger shm status dump to syslog
+
+ 4. corex.shm_summary
+        Trigger shm summary dump to syslog
 
index b911790..d728f47 100644 (file)
@@ -6,9 +6,11 @@ RPC Exports for dialog
 
  1. dlg.list
         Print all dialogs
+        Returns an array.
 
  2. dlg.list_ctx
         Print all dialogs with associated context
+        Returns an array.
 
  3. dlg.dlg_list
         Print dialog based on callid and fromtag
@@ -25,6 +27,7 @@ RPC Exports for dialog
 
  7. dlg.profile_list
         Lists all the dialogs belonging to a profile
+        Returns an array.
 
  8. dlg.bridge_dlg
         Bridge two SIP addresses in a call using INVITE(hold)-REFER-BYE
diff --git a/doc/rpc_list/rpc_dmq.txt b/doc/rpc_list/rpc_dmq.txt
new file mode 100644 (file)
index 0000000..ac8fce9
--- /dev/null
@@ -0,0 +1,10 @@
+RPC Exports for dmq
+===================
+
+                  [ this file is autogenerated, do not edit ]
+
+
+ 1. dmq.list_nodes
+        Print all nodes
+        Returns an array.
+
index 1314ba5..2c1aac3 100644 (file)
@@ -6,6 +6,7 @@ RPC Exports for htable
 
  1. htable.dump
         Dump the contents of hash table.
+        Returns an array.
 
  2. htable.delete
         Delete one key from a hash table.
@@ -21,10 +22,12 @@ RPC Exports for htable
 
  6. htable.listTables
         List all htables.
+        Returns an array.
 
  7. htable.reload
         Reload hash table.
 
  8. htable.stats
         Statistics about htables.
+        Returns an array.
 
diff --git a/doc/rpc_list/rpc_jsonrpc-s.txt b/doc/rpc_list/rpc_jsonrpc-s.txt
new file mode 100644 (file)
index 0000000..49cb2a4
--- /dev/null
@@ -0,0 +1,10 @@
+RPC Exports for jsonrpc-s
+=========================
+
+                  [ this file is autogenerated, do not edit ]
+
+
+ 1. jsonrpc.echo
+        Sample echo command
+        Returns an array.
+
index 1e9bbea..5141aaa 100644 (file)
@@ -6,4 +6,5 @@ RPC Exports for kex
 
  1. pkg.stats
         Private memory (pkg) statistics per process
+        Returns an array.
 
index 4efb500..c5b8c47 100644 (file)
@@ -6,7 +6,11 @@ RPC Exports for mtree
 
  1. mtree.summary
         Print summary of loaded mtree tables
+        Returns an array.
 
  2. mtree.reload
         Reload mtrees from database to memory
 
+ 3. mtree.match
+        Match prefix value against mtree
+
index b424ee8..014964b 100644 (file)
@@ -7,3 +7,18 @@ RPC Exports for uac
  1. uac.reg_dump
         Dump the contents of user registrations table.
 
+ 2. uac.reg_info
+        Return the details of registration for a particular record.
+
+ 3. uac.reg_enable
+        Enable registration for a particular record.
+
+ 4. uac.reg_disable
+        Disable registration for a particular record.
+
+ 5. uac.reg_reload
+        Reload records from database.
+
+ 6. uac.reg_refresh
+        Refresh a record from database.
+