diff --git a/modules/tcpops/doc/eventroutes.xml b/modules/tcpops/doc/eventroutes.xml index f219b1da091..f1be99f11eb 100644 --- a/modules/tcpops/doc/eventroutes.xml +++ b/modules/tcpops/doc/eventroutes.xml @@ -8,28 +8,73 @@ ]>
- Event routes -
- - <function moreinfo="none">tcp:closed</function> - - - 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. - - - Whether this route is always called, never, or on a per socket basis - is controlled by the closed_event parameter. - - - + Event routes + 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. + +
+ + <function moreinfo="none">tcp:closed</function> + + + Called for each "normal" TCP socket closure by the other side (FIN,ACK). + +
+
+ + <function moreinfo="none">tcp:timeout</function> + + + Called for connection timeouts (unanswered keepalives). + +
+
+ + <function moreinfo="none">tcp:reset</function> + + + Called if the connection is reset by peer (RST). + +
+
+ + <function moreinfo="none">Example</function> + + + ... 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"); } ... - - + +
\ No newline at end of file