diff --git a/src/modules/tcpops/doc/functions.xml b/src/modules/tcpops/doc/functions.xml index 9c6409c4e68..94cefaa776a 100644 --- a/src/modules/tcpops/doc/functions.xml +++ b/src/modules/tcpops/doc/functions.xml @@ -290,6 +290,87 @@ event_route[tcp:closed] { if(tcp_get_conid("127.0.0.1:5060", "$var(conid)")) { xlog("connection id is: $var(conid)\n"); } +... + ]]> + + +
+ + <function>tcp_set_otcpid(conid)</function> + + + Set the value for outbound tcp connection id. + + 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: failure + + + + <function>tcp_set_otcpid</function> usage + + +
+
+ + <function>tcp_set_otcpid_flag(mode)</function> + + + Set or reset the internal flag for using or not the outbound tcp + connection id for sending out. The outbound connection id can be + set by module or by config using tcp_set_otcpid(...) function. An + example of a module setting the otcpid is register via lookup location + function, which sets the filed to the connection id used to receive + the registration request. + + Meaning of the parameters is as follows: + + + mode - if 0, then the flag is reset, + otherwise it is set. + + + + Return values: + + + 1: success + + + -1: failure + + + + Note: if you set the flag to use the outbound tcp connection id, + then custom config changes to the destination address, like + updating the r-uri ($ru) or dst uri ($du) are not resetting it, so + the same already set connection id is used and the SIP request + might be sent to the unexpected destination. Reset the flag in such + case, if you set it previously. + + + <function>tcp_set_otcpid_flag</function> usage +