[sr-dev] git:master:3d4dda0c: tcpops: add documentation for tcp:closed

Module: kamailio Branch: master Commit: 3d4dda0cdc4dc452ae7f796e74fd6056e09662df URL: https://github.com/kamailio/kamailio/commit/3d4dda0cdc4dc452ae7f796e74fd605… Author: Camille Oudot &lt;camille.oudot(a)orange.com&gt; Committer: Camille Oudot &lt;camille.oudot(a)orange.com&gt; Date: 2016-09-06T10:46:43+02:00 tcpops: add documentation for tcp:closed --- Added: modules/tcpops/doc/eventroutes.xml Modified: modules/tcpops/doc/tcpops.xml --- Diff: https://github.com/kamailio/kamailio/commit/3d4dda0cdc4dc452ae7f796e74fd605… Patch: https://github.com/kamailio/kamailio/commit/3d4dda0cdc4dc452ae7f796e74fd605… --- diff --git a/modules/tcpops/doc/eventroutes.xml b/modules/tcpops/doc/eventroutes.xml new file mode 100644 index 0000000..f219b1d --- /dev/null +++ b/modules/tcpops/doc/eventroutes.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding='ISO-8859-1'?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" +"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ + +<!-- Include general documentation entities --> +<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml"> +%docentities; + +]> +<section id="tcpops.ex.event_routes"> + <title>Event routes</title> + <section> + <title> + <function moreinfo="none">tcp:closed</function> + </title> + <para> + This route is called when a socket is closed by the remote party, + or reset, or timeout. The corresponding <emphasis>$conid</emphasis> + variable will be available in the event route. + </para> + <para> + Whether this route is always called, never, or on a per socket basis + is controlled by the <emphasis>closed_event</emphasis> parameter. + </para> + <para> + <programlisting format="linespecific"> +... +event_route[tcp:closed] { + xlog("L_INFO", "TCP connection closed ($conid)\n"); +} +... + </programlisting> + </para> + </section> +</section> \ No newline at end of file diff --git a/modules/tcpops/doc/tcpops.xml b/modules/tcpops/doc/tcpops.xml index fc8d32f..5a2ef8d 100644 --- a/modules/tcpops/doc/tcpops.xml +++ b/modules/tcpops/doc/tcpops.xml @@ -57,6 +57,7 @@ <xi:include href="params.xml"/> <xi:include href="functions.xml"/> + <xi:include href="eventroutes.xml"/> </chapter> </book>