Просмотр исходного кода

ims_ipsec_pcscf: docs for ipsec_destroy_by_contact()

Daniel-Constantin Mierla 1 год назад
Родитель
Сommit
006cca9152
1 измененных файлов с 34 добавлено и 0 удалено
  1. 34 0
      src/modules/ims_ipsec_pcscf/doc/ims_ipsec_pcscf_admin.xml

+ 34 - 0
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>