Browse code

modules: readme files regenerated - tcpops ... [skip ci]

Kamailio Dev authored on 23/06/2021 06:46:24
Showing 1 changed files
... ...
@@ -34,6 +34,7 @@ Olle E. Johansson
34 34
               3.7. tcp_get_conid(hostport, pvname)
35 35
               3.8. tcp_set_otcpid(conid)
36 36
               3.9. tcp_set_otcpid_flag(mode)
37
+              3.10. tcp_close_connection([conid])
37 38
 
38 39
         4. Event routes
39 40
 
... ...
@@ -55,6 +56,7 @@ Olle E. Johansson
55 56
    1.9. tcp_get_conid usage
56 57
    1.10. tcp_set_otcpid usage
57 58
    1.11. tcp_set_otcpid_flag usage
59
+   1.12. tcp_close_connection usage
58 60
 
59 61
 Chapter 1. Admin Guide
60 62
 
... ...
@@ -77,6 +79,7 @@ Chapter 1. Admin Guide
77 79
         3.7. tcp_get_conid(hostport, pvname)
78 80
         3.8. tcp_set_otcpid(conid)
79 81
         3.9. tcp_set_otcpid_flag(mode)
82
+        3.10. tcp_close_connection([conid])
80 83
 
81 84
    4. Event routes
82 85
 
... ...
@@ -152,6 +155,7 @@ end
152 155
    3.7. tcp_get_conid(hostport, pvname)
153 156
    3.8. tcp_set_otcpid(conid)
154 157
    3.9. tcp_set_otcpid_flag(mode)
158
+   3.10. tcp_close_connection([conid])
155 159
 
156 160
 3.1.  tcp_conid_alive(conid)
157 161
 
... ...
@@ -400,6 +404,25 @@ event_route[tcp:closed] {
400 404
         tcp_set_otcpid_flag("$var(cmode)");
401 405
 ...
402 406
 
407
+3.10.  tcp_close_connection([conid])
408
+
409
+   Trigger a close of the connection corresponding to current SIP message
410
+   or to connection id 'conid'.
411
+
412
+   Meaning of the parameters is as follows:
413
+     * conid - the value of tcp connection id. It can be an integer number
414
+       or a variable holding an interver value.
415
+
416
+   Return values:
417
+     * 1: success
418
+     * -1 (or other negative values): failure
419
+
420
+   Example 1.12. tcp_close_connection usage
421
+...
422
+        $var(conid) = 10;
423
+        tcp_close_connection("$var(conid)");
424
+...
425
+
403 426
 4. Event routes
404 427
 
405 428
    4.1. tcp:closed