git:master:66473295: modules: readme files regenerated - tcpops ... - sr-dev

10 Oct 2016

Module: kamailio
Branch: master
Commit: 66473295ab516b862fb2c81aa1a1e35ffc4d88e2
URL: https://github.com/kamailio/kamailio/commit/66473295ab516b862fb2c81aa1a1e35f...
Author: Kamailio Dev kamailio.dev@kamailio.org
Committer: Kamailio Dev kamailio.dev@kamailio.org
Date: 2016-10-10T11:16:15+02:00
modules: readme files regenerated - tcpops ...
---
Modified: modules/tcpops/README
---
Diff:  https://github.com/kamailio/kamailio/commit/66473295ab516b862fb2c81aa1a1e35f...
Patch: https://github.com/kamailio/kamailio/commit/66473295ab516b862fb2c81aa1a1e35f...
---

diff --git a/modules/tcpops/README b/modules/tcpops/README
index 3918b00..b0a0c3b 100644
--- a/modules/tcpops/README
+++ b/modules/tcpops/README
@@ -34,6 +34,9 @@ Olle E. Johansson
         4. Event routes
4.1. tcp:closed
+              4.2. tcp:timeout
+              4.3. tcp:reset
+              4.4. Example
List of Examples
@@ -66,6 +69,9 @@ Chapter 1. Admin Guide
    4. Event routes
4.1. tcp:closed
+        4.2. tcp:timeout
+        4.3. tcp:reset
+        4.4. Example
1. Overview
@@ -289,18 +295,43 @@ event_route[tcp:closed] {
 4. Event routes
4.1. tcp:closed
+   4.2. tcp:timeout
+   4.3. tcp:reset
+   4.4. Example
+
+   The 3 following routes are called when a socket is closed.
+
+   The corresponding $conid , $Ri , $Rp , $si , $sp and $proto variable
+   will be available in the event routes.
+
+   Whether these routes are always called, never, or on a per socket basis
+   is controlled by the closed_event parameter.
4.1.  tcp:closed
-   This route is called when a socket is closed by the remote party, or
-   reset, or timeout. The corresponding $conid variable will be available
-   in the event route.
+   Called for each "normal" TCP socket closure by the other side
+   (FIN,ACK).
+
+4.2.  tcp:timeout
+
+   Called for connection timeouts (unanswered keepalives).
+
+4.3.  tcp:reset
-   Whether this route is always called, never, or on a per socket basis is
-   controlled by the closed_event parameter.
+   Called if the connection is reset by peer (RST).
+
+4.4.  Example
...
 event_route[tcp:closed] {
-    xlog("L_INFO", "TCP connection closed ($conid)\n");
+        xlog("L_INFO", "$proto connection closed ($conid)\n");
+}
+
+event_route[tcp:timeout] {
+        xlog("L_INFO", "$proto connection timed out ($conid)\n");
+}
+
+event_route[tcp:reset] {
+        xlog("L_INFO", "$proto connection reset by peer ($conid)\n");
 }
 ...

    