[sr-dev] git:master: modules/ims_registrar_scscf: updated documentation

Module: sip-router Branch: master Commit: 02edf111af9d13e5bed1de768ca9f206a3537483 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=02edf11… Author: Richard Good &lt;richard.good(a)smilecoms.com&gt; Committer: Richard Good &lt;richard.good(a)smilecoms.com&gt; Date: Fri Mar 7 11:08:51 2014 +0200 modules/ims_registrar_scscf: updated documentation --- .../doc/ims_registrar_scscf_admin.xml | 78 +++++++++++++++++++- 1 files changed, 77 insertions(+), 1 deletions(-) diff --git a/modules/ims_registrar_scscf/doc/ims_registrar_scscf_admin.xml b/modules/ims_registrar_scscf/doc/ims_registrar_scscf_admin.xml index 00b9b5c..26de7fc 100644 --- a/modules/ims_registrar_scscf/doc/ims_registrar_scscf_admin.xml +++ b/modules/ims_registrar_scscf/doc/ims_registrar_scscf_admin.xml @@ -686,7 +686,83 @@ if (can_subscribe_to_reg("location")){ </programlisting> </example> </section> - </section> + + <section> + <title><function + moreinfo="none">can_publish_reg(domain)</function></title> + + <para>This function checks to see that a PUBLISH request is authorised + to publish for a particular identity. Only 3 entities can + publish:</para> + + <itemizedlist> + <listitem> + <para><emphasis>The user agent to it's own state</emphasis></para> + </listitem> + + <listitem> + <para>The P-CSCF specified in the path header for that user</para> + </listitem> + + <listitem> + <para>Application Server (AS) not yet implemented</para> + </listitem> + </itemizedlist> + + <para>Meaning of the parameters is as follows:</para> + + <itemizedlist> + <listitem> + <para><emphasis>domain - Logical domain within + registrar.</emphasis></para> + </listitem> + </itemizedlist> + + <para>This function can be used in REQUEST_ROUTE</para> + + <example> + <title><function>can_publish_reg</function> usage</title> + + <programlisting format="linespecific">... +if (can_publish_reg("location")){ + $var(ret)= publish_reg("location"); +} +... +</programlisting> + </example> + </section> + + <section> + <title><function + moreinfo="none">publish_reg(domain)</function></title> + + <para>Save the publish to the REG event for the UAC or the + appropriate P-CSCF (in the path to the UAC).</para> + + <para>Meaning of the parameters is as follows:</para> + + <itemizedlist> + <listitem> + <para><emphasis>domain - Logical domain within + registrar.</emphasis></para> + </listitem> + </itemizedlist> + + <para>This function can be used in REQUEST_ROUTE</para> + + <example> + <title><function>publish_reg</function> usage</title> + + <programlisting format="linespecific">... +if (can_publish_reg("location")){ + $var(ret)= publish_reg("location"); +} +... +</programlisting> + </example> + </section> + + </section> <section> <title>RPC Commands</title>