瀏覽代碼

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

Daniel-Constantin Mierla 11 年之前
父節點
當前提交
dfaf1f1cf9
共有 2 個文件被更改,包括 53 次插入5 次删除
  1. 25 5
      modules/corex/README
  2. 28 0
      modules/corex/doc/corex_admin.xml

+ 25 - 5
modules/corex/README

@@ -37,6 +37,8 @@ Daniel-Constantin Mierla
 
 
               5.1. corex.list_sockets
               5.1. corex.list_sockets
               5.2. corex.list_aliases
               5.2. corex.list_aliases
+              5.3. corex.shm_status
+              5.4. corex.shm_summary
 
 
    List of Examples
    List of Examples
 
 
@@ -68,6 +70,8 @@ Chapter 1. Admin Guide
 
 
         5.1. corex.list_sockets
         5.1. corex.list_sockets
         5.2. corex.list_aliases
         5.2. corex.list_aliases
+        5.3. corex.shm_status
+        5.4. corex.shm_summary
 
 
 1. Overview
 1. Overview
 
 
@@ -123,7 +127,7 @@ modparam("corex", "alias_subdomains", "udp:sip-router.org:5060")
    4.2. send([ host [ :port ] ])
    4.2. send([ host [ :port ] ])
    4.3. send_tcp([ 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
    Append a new branch to the destination set, useful to build the set of
    destination addresses for parallel forking or redirect replies.
    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");
     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
    Send the original SIP message to a specific destination in stateless
    mode. No changes are applied to received message, no Via header is
    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)");
         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
    This function is identical to send() described above, except that it
    sends the SIP message using the TCP protocol instead of UDP.
    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.1. corex.list_sockets
    5.2. corex.list_aliases
    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.
    Print the list of sockets the application is listening on.
 
 
    Example:
    Example:
                 kamcmd corex.list_sockets
                 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.
    Print the list of hostname aliases used to match the myself condition.
 
 
    Example:
    Example:
                 kamcmd corex.list_aliases
                 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

+ 28 - 0
modules/corex/doc/corex_admin.xml

@@ -210,6 +210,34 @@ modparam("corex", "alias_subdomains", "udp:sip-router.org:5060")
         <programlisting  format="linespecific">
         <programlisting  format="linespecific">
 		&sercmd; corex.list_aliases
 		&sercmd; corex.list_aliases
 		</programlisting>
 		</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>
     </section>
     </section>
 </chapter>
 </chapter>