diff --git a/src/modules/keepalive/doc/keepalive_admin.xml b/src/modules/keepalive/doc/keepalive_admin.xml index 98e55222eaf..5b74c6e4cc5 100644 --- a/src/modules/keepalive/doc/keepalive_admin.xml +++ b/src/modules/keepalive/doc/keepalive_admin.xml @@ -169,10 +169,22 @@ if(ka_is_alive("192.168.10.20") == 1) {
- <function moreinfo="none">ka_add_destination(sip_uri)</function> + <function moreinfo="none">ka_add_destination(sip_uri, owner)</function> - Adds destination sip/sips uri in memory list to keep alive . + Adds SIP URI in the memory destinations list to perform keep alive to it. + + + Meaning of the parameters: + + sip_uri (string) - address of destination to monitor. + Valid format is [protoschema:]ip[:port], with: 'protoschema' being + one of 'sip' or 'sips' (SIP over TLS) - if omitted, 'sip'is used + by default; 'port' is optional (using default standard port 5060 + for sip and 5061 for sips) + owner (string) - module name “owning” the destination + (for informational purpose) + Returned value: @@ -185,25 +197,38 @@ if(ka_is_alive("192.168.10.20") == 1) { This function can be used from REQUEST_ROUTE,BRANCH_ROUTE,ONREPLY_ROUTE. - <function>ka_add_destination(sip_uri)</function> usage + <function>ka_add_destination(sip_uri, ownder)</function> usage ... $avp(duri1)="sip:192.168.1.10:5060;transport=tcp"; $avp(duri2)="sip:192.168.1.11:5061"; $avp(duri3)="sip:192.168.1.12" -ka_add_destination("$avp(duri3)"); -ka_add_destination("sip:192.168.1.10:5060;transport=tcp"); +ka_add_destination("$avp(duri3)", "config"); +ka_add_destination("sip:192.168.1.10:5060;transport=tcp", "config"); ...
- <function moreinfo="none">ka_del_destination(sip_uri)</function> + <function moreinfo="none">ka_del_destination(sip_uri, owner)</function> - Deletes destination sip/sips uri in memory list . + Deletes the SIP URI from the memory destinations list used for monitoring. + + Meaning of the parameters: + + sip_uri (string) - address of monitored destination. + Valid format is [protoschema:]ip[:port], with: 'protoschema' being + one of 'sip' or 'sips' (SIP over TLS) - if omitted, 'sip'is used + by default; 'port' is optional (using default standard port 5060 + for sip and 5061 for sips) + owner (string) - module name “owning” the destination + (for informational purpose) + + + Returned value: @@ -215,14 +240,14 @@ ka_add_destination("sip:192.168.1.10:5060;transport=tcp"); This function can be used from ANY_ROUTE. - <function>ka_del_destination(sip_uri)</function> usage + <function>ka_del_destination(sip_uri, owner)</function> usage ... $avp(duri1)="sip:192.168.1.10:5060;transport=tcp"; $avp(duri2)="sip:192.168.1.11:5061"; $avp(duri3)="sip:192.168.1.12" -ka_del_destination("$avp(duri3)"); -ka_del_destination("sip:192.168.1.10:5060;transport=tcp"); +ka_del_destination("$avp(duri3)", "config"); +ka_del_destination("sip:192.168.1.10:5060;transport=tcp", "config"); ...