[sr-dev] git:master: corex: documented the new parameter alias_subdomains

Module: sip-router Branch: master Commit: 95581558c230054b082200f10509b8c61e036131 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=9558155… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Tue Sep 11 22:02:21 2012 +0200 corex: documented the new parameter alias_subdomains --- modules/corex/README | 68 ++++++++++++++++++++++++++----------- modules/corex/doc/corex_admin.xml | 28 +++++++++++++++ 2 files changed, 76 insertions(+), 20 deletions(-) diff --git a/modules/corex/README b/modules/corex/README index 5cffb3c..68860dd 100644 --- a/modules/corex/README +++ b/modules/corex/README @@ -23,18 +23,23 @@ Daniel-Constantin Mierla 2.1. Kamailio Modules 2.2. External Libraries or Applications - 3. Functions + 3. Parameters - 3.1. append_branch([ uri, [ q ] ]) + 3.1. alias_subdomains (string) - 4. RPC Commands + 4. Functions - 4.1. corex.list_sockets - 4.2. corex.list_aliases + 4.1. append_branch([ uri, [ q ] ]) + + 5. RPC Commands + + 5.1. corex.list_sockets + 5.2. corex.list_aliases List of Examples - 1.1. append_branch usage + 1.1. Set alias_subdomains parameter + 1.2. append_branch usage Chapter 1. Admin Guide @@ -46,14 +51,18 @@ Chapter 1. Admin Guide 2.1. Kamailio Modules 2.2. External Libraries or Applications - 3. Functions + 3. Parameters + + 3.1. alias_subdomains (string) - 3.1. append_branch([ uri, [ q ] ]) + 4. Functions - 4. RPC Commands + 4.1. append_branch([ uri, [ q ] ]) - 4.1. corex.list_sockets - 4.2. corex.list_aliases + 5. RPC Commands + + 5.1. corex.list_sockets + 5.2. corex.list_aliases 1. Overview @@ -84,11 +93,30 @@ Chapter 1. Admin Guide running Kamailio with this module loaded: * None -3. Functions +3. Parameters + + 3.1. alias_subdomains (string) + +3.1. alias_subdomains (string) + + Register a domain and all its sub-domains to match the myself + condition. It can be set many times. Its full format is: + 'proto:domain:port', allowing to set restrictions on protocol and port + as well. Protocol and port are optional. + + Default value is "NULL". + + Example 1.1. Set alias_subdomains parameter +... +modparam("corex", "alias_subdomain", "kamailio.org") +modparam("corex", "alias_subdomain", "udp:sip-router.org:5060") +... + +4. Functions - 3.1. append_branch([ uri, [ q ] ]) + 4.1. append_branch([ uri, [ q ] ]) -3.1. append_branch([ uri, [ q ] ]) +4.1. append_branch([ uri, [ q ] ]) Append a new branch to the destination set, useful to build the addresses for parallel forking or redirect replies. @@ -104,25 +132,25 @@ Chapter 1. Admin Guide This function can be used from REQUEST_ROUTE or FAILURE_ROUTE. - Example 1.1. append_branch usage + Example 1.2. append_branch usage ... append_branch(); append_branch("$avp(uri)", "0.5"); ... -4. RPC Commands +5. RPC Commands - 4.1. corex.list_sockets - 4.2. corex.list_aliases + 5.1. corex.list_sockets + 5.2. corex.list_aliases -4.1. corex.list_sockets +5.1. corex.list_sockets Print the list of sockets the application is listening on. Example: sercmd corex.list_sockets -4.2. corex.list_aliases +5.2. corex.list_aliases Print the list of hostname aliases used to match myself condition. diff --git a/modules/corex/doc/corex_admin.xml b/modules/corex/doc/corex_admin.xml index bc01fe5..4ceb77b 100644 --- a/modules/corex/doc/corex_admin.xml +++ b/modules/corex/doc/corex_admin.xml @@ -61,6 +61,34 @@ </para> </section> </section> + + <section> + <title>Parameters</title> + <section> + <title><varname>alias_subdomains</varname> (string)</title> + <para> + Register a domain and all its sub-domains to match the myself + condition. It can be set many times. Its full format is: + 'proto:domain:port', allowing to set restrictions on protocol + and port as well. Protocol and port are optional. + </para> + <para> + <emphasis> + Default value is <quote>NULL</quote>. + </emphasis> + </para> + <example> + <title>Set <varname>alias_subdomains</varname> parameter</title> + <programlisting format="linespecific"> +... +modparam("corex", "alias_subdomain", "kamailio.org") +modparam("corex", "alias_subdomain", "udp:sip-router.org:5060") +... +</programlisting> + </example> + </section> + </section> + <section> <title>Functions</title> <section>