Browse Source

tcpops: add documentation for tcp:closed

Camille Oudot 9 years ago
parent
commit
3d4dda0cdc
2 changed files with 36 additions and 0 deletions
  1. 35 0
      modules/tcpops/doc/eventroutes.xml
  2. 1 0
      modules/tcpops/doc/tcpops.xml

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

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