[sr-dev] git:master: corex: documented corex.shm_status and corex. shm_summary rpc commands

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Tue Apr  8 15:31:56 2014 +0200

corex: documented corex.shm_status and corex.shm_summary rpc commands

---

 modules/corex/README              |   30 +++++++++++++++++++++++++-----
 modules/corex/doc/corex_admin.xml |   28 ++++++++++++++++++++++++++++
 2 files changed, 53 insertions(+), 5 deletions(-)

diff --git a/modules/corex/README b/modules/corex/README
index 35520b4..9c1aecf 100644
--- a/modules/corex/README
+++ b/modules/corex/README
@@ -37,6 +37,8 @@ Daniel-Constantin Mierla
 
               5.1. corex.list_sockets
               5.2. corex.list_aliases
+              5.3. corex.shm_status
+              5.4. corex.shm_summary
 
    List of Examples
 
@@ -68,6 +70,8 @@ Chapter 1. Admin Guide
 
         5.1. corex.list_sockets
         5.2. corex.list_aliases
+        5.3. corex.shm_status
+        5.4. corex.shm_summary
 
 1. Overview
 
@@ -123,7 +127,7 @@ modparam("corex", "alias_subdomains", "udp:sip-router.org:5060")
    4.2. send([ host [ :port ] ])
    4.3. send_tcp([ host [ :port ] ])
 
-4.1.  append_branch([ uri, [ q ] ])
+4.1. append_branch([ uri, [ q ] ])
 
    Append a new branch to the destination set, useful to build the set of
    destination addresses for parallel forking or redirect replies.
@@ -145,7 +149,7 @@ modparam("corex", "alias_subdomains", "udp:sip-router.org:5060")
     append_branch("$avp(uri)", "0.5");
 ...
 
-4.2.  send([ host [ :port ] ])
+4.2. send([ host [ :port ] ])
 
    Send the original SIP message to a specific destination in stateless
    mode. No changes are applied to received message, no Via header is
@@ -167,7 +171,7 @@ modparam("corex", "alias_subdomains", "udp:sip-router.org:5060")
         send("$var(res)");
 ...
 
-4.3.  send_tcp([ host [ :port ] ])
+4.3. send_tcp([ host [ :port ] ])
 
    This function is identical to send() described above, except that it
    sends the SIP message using the TCP protocol instead of UDP.
@@ -176,17 +180,33 @@ modparam("corex", "alias_subdomains", "udp:sip-router.org:5060")
 
    5.1. corex.list_sockets
    5.2. corex.list_aliases
+   5.3. corex.shm_status
+   5.4. corex.shm_summary
 
-5.1.  corex.list_sockets
+5.1. corex.list_sockets
 
    Print the list of sockets the application is listening on.
 
    Example:
                 kamcmd corex.list_sockets
 
-5.2.  corex.list_aliases
+5.2. corex.list_aliases
 
    Print the list of hostname aliases used to match the myself condition.
 
    Example:
                 kamcmd corex.list_aliases
+
+5.3. corex.shm_status
+
+   Trigger shm status dump to syslog.
+
+   Example:
+                kamcmd corex.shm_status
+
+5.4. corex.shm_summary
+
+   Trigger shm summary dump to syslog.
+
+   Example:
+                kamcmd corex.shm_summary
diff --git a/modules/corex/doc/corex_admin.xml b/modules/corex/doc/corex_admin.xml
index 1e97986..e7a75a5 100644
--- a/modules/corex/doc/corex_admin.xml
+++ b/modules/corex/doc/corex_admin.xml
@@ -211,6 +211,34 @@ modparam("corex", "alias_subdomains", "udp:sip-router.org:5060")
 		&sercmd; corex.list_aliases
 		</programlisting>
     </section>
+	<section>
+		<title>
+		<function moreinfo="none">corex.shm_status</function>
+		</title>
+		<para>
+			Trigger shm status dump to syslog.
+		</para>
+		<para>
+		Example:
+		</para>
+        <programlisting  format="linespecific">
+		&sercmd; corex.shm_status
+		</programlisting>
+	</section>
+	<section>
+		<title>
+		<function moreinfo="none">corex.shm_summary</function>
+		</title>
+		<para>
+			Trigger shm summary dump to syslog.
+		</para>
+		<para>
+		Example:
+		</para>
+        <programlisting  format="linespecific">
+		&sercmd; corex.shm_summary
+		</programlisting>
+    </section>
     </section>
 </chapter>