Module: sip-router Branch: carstenbock/ims Commit: 5479620417f017109985ee10d485a0da85588d81 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=5479620… Author: Carsten Bock &lt;carsten(a)bock.info&gt; Committer: Carsten Bock &lt;carsten(a)bock.info&gt; Date: Thu Mar 10 14:11:11 2011 +0100 - Updated Typo in the docs (thanks Klaus) - added a note about reg_avp behaviour. --- modules_k/registrar/doc/registrar_admin.xml | 21 ++++++++++++++++++--- 1 files changed, 18 insertions(+), 3 deletions(-) diff --git a/modules_k/registrar/doc/registrar_admin.xml b/modules_k/registrar/doc/registrar_admin.xml index 13947d1..b809338 100644 --- a/modules_k/registrar/doc/registrar_admin.xml +++ b/modules_k/registrar/doc/registrar_admin.xml @@ -660,10 +660,13 @@ modparam("registrar", "reg_avp", "$avp(i:2)") The function processes a REGISTER message. It can add, remove or modify usrloc records depending on Contact and Expires HFs in the REGISTER message. On success and when called from the REQUEST_ROUTE, - 200 OK will be returned listing all contacts that are currently in + 200 OK will be returned listing all contacts that are currently in usrloc. On an error, error message will be send with a short description in reason phrase. </para> + <para> + This function will save the AVP's for this contact. + </para> <para>Meaning of the parameters is as follows:</para> <itemizedlist> <listitem> @@ -715,6 +718,9 @@ save("location"); Same as <function>save()</function> but it accepts a set of flags for controlling its behaviour. </para> + <para> + This function will save the AVP's for this contact. + </para> <para>Meaning of the parameters is as follows:</para> <itemizedlist> <listitem> @@ -776,6 +782,9 @@ save("location","0x01"); the message (depending on append_branches parameter value). </para> <para> + This function will restore the AVP's for this contact. + </para> + <para> If the method_filtering option is enabled, the lookup function will return only the contacts that support the method of the processed request. @@ -837,7 +846,10 @@ switch ($retcode) { The function returns true if the AOR in the Request-URI is registered, false otherwise. The function does not modify the message being processed, it neither rewrites the Request-URI if a - contact is found not append branches. + contact is found nor appends branches. + </para> + <para> + This function will restore the AVP's for this contact. </para> <para>Meaning of the parameters is as follows:</para> <itemizedlist> @@ -873,7 +885,10 @@ if (registered("location")) { registered, false otherwise. The function does not modify the message being processed, it neither rewrites the Request-URI if a - contact is found not append branches. + contact is found nor appends branches. + </para> + <para> + This function will restore the AVP's for this contact. </para> <para>Meaning of the parameters is as follows:</para> <itemizedlist>