Selaa lähdekoodia

tls Update README with RPC commands

The selects are still missing.
Olle E. Johansson 12 vuotta sitten
vanhempi
commit
e59acd4d00
4 muutettua tiedostoa jossa 115 lisäystä ja 15 poistoa
  1. 44 8
      modules/tls/README
  2. 1 3
      modules/tls/doc/functions.xml
  3. 68 0
      modules/tls/doc/rpc.xml
  4. 2 4
      modules/tls/doc/tls.xml

+ 44 - 8
modules/tls/README

@@ -52,7 +52,14 @@ Andrei Pelinescu-Onciul
 
 
         1.10.1. is_peer_verified()
         1.10.1. is_peer_verified()
 
 
-   1.11. History
+   1.11. RPC Commands
+
+        1.11.1. tls.info
+        1.11.2. tls.list
+        1.11.3. tls.options
+        1.11.4. tls.reload
+
+   1.12. History
 
 
 1.1. Overview
 1.1. Overview
 
 
@@ -197,12 +204,9 @@ make -C modules/tls extra_defs="-DTLS_WR_DEBUG -DTLS_RD_DEBUG"
    TLS specific config reloading is not safe, so for now better don't use
    TLS specific config reloading is not safe, so for now better don't use
    it, especially under heavy traffic.
    it, especially under heavy traffic.
 
 
-   This documentation is incomplete. The RPCs are not documented here, but
-   in doc/rpc_list/rpc_tls.txt or
-   http://sip-router.org/docbook/sip-router/branch/master/rpc_list/rpc_lis
-   t.html#rpc_exports.tls. The provided selects are not documented. A list
-   with all the ones implemented by the tls module can be seen under
-   doc/select_list/select_tls.txt or or
+   This documentation is incomplete. The provided selects are not
+   documented. A list with all the ones implemented by the TLS module can
+   be seen under doc/select_list/select_tls.txt or or
    http://sip-router.org/docbook/sip-router/branch/master/select_list/sele
    http://sip-router.org/docbook/sip-router/branch/master/select_list/sele
    ct_list.html#select_list.tls.
    ct_list.html#select_list.tls.
 
 
@@ -1017,7 +1021,39 @@ modparam("tls", "config", "/usr/local/etc/ser/tls.cfg")
                 drop;
                 drop;
         }
         }
 
 
-1.11. History
+1.11. RPC Commands
+
+1.11.1. tls.info
+
+   List internal information related to the TLS module in a short list -
+   max connections, opened connections and the write queue size.
+
+   Parameters:
+     * None.
+
+1.11.2. tls.list
+
+   List details about all active TLS connections.
+
+   Parameters:
+     * None.
+
+1.11.3. tls.options
+
+   List the current TLS configuration.
+
+   Parameters:
+     * None.
+
+1.11.4. tls.reload
+
+   Reload the external TLS configuration file. (Does not reload modparam()
+   parameters)
+
+   Parameters:
+     * None.
+
+1.12. History
 
 
    This module was put together by Jan Janak <[email protected]> from code
    This module was put together by Jan Janak <[email protected]> from code
    from the experimental tls core addon
    from the experimental tls core addon

+ 1 - 3
modules/tls/doc/functions.xml

@@ -8,7 +8,7 @@
 
 
 ]>
 ]>
 
 
-<section id="textops.functions">
+<section id="tls.functions">
 	<sectioninfo>
 	<sectioninfo>
 	</sectioninfo>
 	</sectioninfo>
 
 
@@ -32,6 +32,4 @@
 			</programlisting>
 			</programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
-
-
 </section>
 </section>

+ 68 - 0
modules/tls/doc/rpc.xml

@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+<!-- Include general documentation entities -->
+<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
+%docentities;
+
+]>
+
+<section id="tls.rpc">
+	<sectioninfo>
+	</sectioninfo>
+	<title>RPC Commands</title>
+	<section id="tls.info">
+		<title><function>tls.info</function></title>
+		<para>
+			List internal information related to the TLS module in 
+			a short list - max connections, opened connections and the 
+			write queue size.
+		</para>
+		<para>Parameters: </para>
+                <itemizedlist>
+                        <listitem><para>
+                                None.
+                        </para></listitem>
+                </itemizedlist>
+	</section>
+	<section id="tls.list">
+		<title><function>tls.list</function></title>
+		<para>
+			List details about all active TLS connections.
+		</para>
+		<para>Parameters: </para>
+                <itemizedlist>
+                        <listitem><para>
+                                None.
+                        </para></listitem>
+                </itemizedlist>
+	</section>
+	<section id="tls.options">
+		<title><function>tls.options</function></title>
+		<para>
+			List the current TLS configuration.
+		</para>
+		<para>Parameters: </para>
+                <itemizedlist>
+                        <listitem><para>
+                                None.
+                        </para></listitem>
+                </itemizedlist>
+	</section>
+	<section id="tls.reload">
+		<title><function>tls.reload</function></title>
+		<para>
+			Reload the external TLS configuration file. (Does not reload 
+			modparam() parameters)
+		</para>
+		<para>Parameters: </para>
+                <itemizedlist>
+                        <listitem><para>
+                                None.
+                        </para></listitem>
+                </itemizedlist>
+	</section>
+
+
+</section>

+ 2 - 4
modules/tls/doc/tls.xml

@@ -168,11 +168,8 @@ make -C modules/tls extra_defs="-DTLS_WR_DEBUG -DTLS_RD_DEBUG"
 		</para>
 		</para>
 		<para>
 		<para>
 			This documentation is incomplete.
 			This documentation is incomplete.
-			The RPCs are not documented here, but in doc/rpc_list/rpc_tls.txt
-			or <ulink url="http://sip-router.org/docbook/sip-router/branch/master/rpc_list/rpc_list.html#rpc_exports.tls">
-			http://sip-router.org/docbook/sip-router/branch/master/rpc_list/rpc_list.html#rpc_exports.tls</ulink>.
 			The provided selects are not documented. A list with all the
 			The provided selects are not documented. A list with all the
-			ones implemented by the tls module can be seen under
+			ones implemented by the TLS module can be seen under
 			doc/select_list/select_tls.txt or
 			doc/select_list/select_tls.txt or
 			or <ulink url="http://sip-router.org/docbook/sip-router/branch/master/select_list/select_list.html#select_list.tls">
 			or <ulink url="http://sip-router.org/docbook/sip-router/branch/master/select_list/select_list.html#select_list.tls">
 			http://sip-router.org/docbook/sip-router/branch/master/select_list/select_list.html#select_list.tls</ulink>.
 			http://sip-router.org/docbook/sip-router/branch/master/select_list/select_list.html#select_list.tls</ulink>.
@@ -182,6 +179,7 @@ make -C modules/tls extra_defs="-DTLS_WR_DEBUG -DTLS_RD_DEBUG"
 	<xi:include href="certs_howto.xml"/>
 	<xi:include href="certs_howto.xml"/>
 	<xi:include href="params.xml"/>
 	<xi:include href="params.xml"/>
 	<xi:include href="functions.xml"/>
 	<xi:include href="functions.xml"/>
+	<xi:include href="rpc.xml"/>
 	<xi:include href="history.xml"/>
 	<xi:include href="history.xml"/>
 
 
 </section>
 </section>