[sr-dev] git:master:7979925f: modules: readme files regenerated - tcpops ... [skip ci]

Module: kamailio Branch: master Commit: 7979925ff2a53dcc2111c1ebbbc94b2cac6103df URL: https://github.com/kamailio/kamailio/commit/7979925ff2a53dcc2111c1ebbbc94b2… Author: Kamailio Dev <kamailio.dev(a)kamailio.org> Committer: Kamailio Dev <kamailio.dev(a)kamailio.org> Date: 2021-06-23T08:46:24+02:00 modules: readme files regenerated - tcpops ... [skip ci] --- Modified: src/modules/tcpops/README --- Diff: https://github.com/kamailio/kamailio/commit/7979925ff2a53dcc2111c1ebbbc94b2… Patch: https://github.com/kamailio/kamailio/commit/7979925ff2a53dcc2111c1ebbbc94b2… --- diff --git a/src/modules/tcpops/README b/src/modules/tcpops/README index 70209686f0..5bbd683440 100644 --- a/src/modules/tcpops/README +++ b/src/modules/tcpops/README @@ -34,6 +34,7 @@ Olle E. Johansson 3.7. tcp_get_conid(hostport, pvname) 3.8. tcp_set_otcpid(conid) 3.9. tcp_set_otcpid_flag(mode) + 3.10. tcp_close_connection([conid]) 4. Event routes @@ -55,6 +56,7 @@ Olle E. Johansson 1.9. tcp_get_conid usage 1.10. tcp_set_otcpid usage 1.11. tcp_set_otcpid_flag usage + 1.12. tcp_close_connection usage Chapter 1. Admin Guide @@ -77,6 +79,7 @@ Chapter 1. Admin Guide 3.7. tcp_get_conid(hostport, pvname) 3.8. tcp_set_otcpid(conid) 3.9. tcp_set_otcpid_flag(mode) + 3.10. tcp_close_connection([conid]) 4. Event routes @@ -152,6 +155,7 @@ end 3.7. tcp_get_conid(hostport, pvname) 3.8. tcp_set_otcpid(conid) 3.9. tcp_set_otcpid_flag(mode) + 3.10. tcp_close_connection([conid]) 3.1. tcp_conid_alive(conid) @@ -400,6 +404,25 @@ event_route[tcp:closed] { tcp_set_otcpid_flag("$var(cmode)"); ... +3.10. tcp_close_connection([conid]) + + Trigger a close of the connection corresponding to current SIP message + or to connection id 'conid'. + + Meaning of the parameters is as follows: + * conid - the value of tcp connection id. It can be an integer number + or a variable holding an interver value. + + Return values: + * 1: success + * -1 (or other negative values): failure + + Example 1.12. tcp_close_connection usage +... + $var(conid) = 10; + tcp_close_connection("$var(conid)"); +... + 4. Event routes 4.1. tcp:closed