[sr-dev] git:master:006cca91: ims_ipsec_pcscf: docs for ipsec_destroy_by_contact()

Module: kamailio Branch: master Commit: 006cca915275f8ca3ea52a9d978961e0842f1dcd URL: https://github.com/kamailio/kamailio/commit/006cca915275f8ca3ea52a9d978961e… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2023-11-30T10:18:47+01:00 ims_ipsec_pcscf: docs for ipsec_destroy_by_contact() --- Modified: src/modules/ims_ipsec_pcscf/doc/ims_ipsec_pcscf_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/006cca915275f8ca3ea52a9d978961e… Patch: https://github.com/kamailio/kamailio/commit/006cca915275f8ca3ea52a9d978961e… --- diff --git a/src/modules/ims_ipsec_pcscf/doc/ims_ipsec_pcscf_admin.xml b/src/modules/ims_ipsec_pcscf/doc/ims_ipsec_pcscf_admin.xml index d50c66ed45a..24d77440d89 100644 --- a/src/modules/ims_ipsec_pcscf/doc/ims_ipsec_pcscf_admin.xml +++ b/src/modules/ims_ipsec_pcscf/doc/ims_ipsec_pcscf_admin.xml @@ -367,6 +367,40 @@ ipsec_forward("location", "1"); <programlisting format="linespecific"> ... ipsec_destroy("location"); +... + </programlisting> + </example> + </section> + <section> + <title><function moreinfo="none">ipsec_destroy_by_contact(domain, aor, recv_host, recv_port)</function></title> + <para>The function destroys IPSec tunnel, created with ipsec_create.</para> + <para>Meaning of the parameters is as follows:</para> + <itemizedlist> + <listitem> + <para> + <emphasis>domain</emphasis> - Logical domain within the registrar. + If a database is used then this must be name of the table which + stores the contacts. + </para> + <para> + <emphasis>aor</emphasis> - SIP URI to match the record. + </para> + <para> + <emphasis>recv_host</emphasis> - received host to match the record. + </para> + <para> + <emphasis>recv_port</emphasis> - received port to match the record. + </para> + </listitem> + </itemizedlist> + <para>The last three parameters have to be string valies and can contain + variables.</para> + <example> + <title>ipsec_destroy_by_contact()</title> + + <programlisting format="linespecific"> +... +ipsec_destroy_by_contact("location", "...", "...", "..."); ... </programlisting> </example>