Browse code

ka_add_destination, ka_del_destination requires owner param

ka_add_destination, ka_del_destination requires owner param.

sagarmalam authored on 12/08/2020 14:14:23 • GitHub committed on 12/08/2020 14:14:23
Showing 1 changed files
... ...
@@ -40,8 +40,8 @@ Yasin CANER
40 40
               2.4. Functions
41 41
 
42 42
                     2.4.1. ka_is_alive(destination)
43
-                    2.4.2. ka_add_destination(sip_uri)
44
-                    2.4.3. ka_del_destination(sip_uri)
43
+                    2.4.2. ka_add_destination(sip_uri,owner)
44
+                    2.4.3. ka_del_destination(sip_uri,owner)
45 45
 
46 46
               2.5. RPC Commands
47 47
 
... ...
@@ -67,8 +67,8 @@ Yasin CANER
67 67
    1.3. Set delete_counter parameter
68 68
    1.4. Set ping_from parameter
69 69
    1.5. ka_is_alive() usage
70
-   1.6. ka_add_destination(sip_uri) usage
71
-   1.7. ka_del_destination(sip_uri) usage
70
+   1.6. ka_add_destination(sip_uri,owner) usage
71
+   1.7. ka_del_destination(sip_uri,owner) usage
72 72
    1.8. keepalive.list RPC example
73 73
    1.9. keepalive.add RPC example
74 74
    1.10. keepalive.del RPC example
... ...
@@ -96,8 +96,8 @@ Chapter 1. Admin Guide
96 96
         2.4. Functions
97 97
 
98 98
               2.4.1. ka_is_alive(destination)
99
-              2.4.2. ka_add_destination(sip_uri)
100
-              2.4.3. ka_del_destination(sip_uri)
99
+              2.4.2. ka_add_destination(sip_uri,owner)
100
+              2.4.3. ka_del_destination(sip_uri,owner)
101 101
 
102 102
         2.5. RPC Commands
103 103
 
... ...
@@ -131,8 +131,8 @@ Chapter 1. Admin Guide
131 131
    2.4. Functions
132 132
 
133 133
         2.4.1. ka_is_alive(destination)
134
-        2.4.2. ka_add_destination(sip_uri)
135
-        2.4.3. ka_del_destination(sip_uri)
134
+        2.4.2. ka_add_destination(sip_uri,owner)
135
+        2.4.3. ka_del_destination(sip_uri,owner)
136 136
 
137 137
    2.5. RPC Commands
138 138
 
... ...
@@ -222,9 +222,19 @@ if(ka_is_alive("192.168.10.20") == 1) {
222 222
 };
223 223
 ...
224 224
 
225
-2.4.2.  ka_add_destination(sip_uri)
225
+2.4.2.  ka_add_destination(sip_uri,owner)
226 226
 
227 227
    Adds destination sip/sips uri in memory list to keep alive .
228
+   
229
+   Meaning of the parameters is as follows:
230
+     * sip_uri (string) - address of destination to monitor. Valid format is
231
+       [proto:]ip[:port], with:
232
+          + proto being one of sip or sips (SIP over TLS). If omitted, sip
233
+            is used by default
234
+          + port being optional (using default standard port, 5060 for sip
235
+            and 5061 for sips)
236
+     * owner (string) - module name “owning” the destination (for
237
+       information purpose)
228 238
 
229 239
    Returned value:
230 240
      * 1 - successful
... ...
@@ -233,18 +243,28 @@ if(ka_is_alive("192.168.10.20") == 1) {
233 243
    This function can be used from
234 244
    REQUEST_ROUTE,BRANCH_ROUTE,ONREPLY_ROUTE.
235 245
 
236
-   Example 1.6. ka_add_destination(sip_uri) usage
246
+   Example 1.6. ka_add_destination(sip_uri,owner) usage
237 247
 ...
238 248
 $avp(duri1)="sip:192.168.1.10:5060;transport=tcp";
239 249
 $avp(duri2)="sip:192.168.1.11:5061";
240 250
 $avp(duri3)="sip:192.168.1.12"
241
-ka_add_destination("$avp(duri3)");
242
-ka_add_destination("sip:192.168.1.10:5060;transport=tcp");
251
+ka_add_destination("$avp(duri3)","config");
252
+ka_add_destination("sip:192.168.1.10:5060;transport=tcp","config");
243 253
 ...
244 254
 
245
-2.4.3.  ka_del_destination(sip_uri)
255
+2.4.3.  ka_del_destination(sip_uri,owner)
246 256
 
247 257
    Deletes destination sip/sips uri in memory list .
258
+   
259
+   Meaning of the parameters is as follows:
260
+     * sip_uri (string) - address of destination to monitor. Valid format is
261
+       [proto:]ip[:port], with:
262
+          + proto being one of sip or sips (SIP over TLS). If omitted, sip
263
+            is used by default
264
+          + port being optional (using default standard port, 5060 for sip
265
+            and 5061 for sips)
266
+     * owner (string) - module name “owning” the destination (for
267
+       information purpose)
248 268
 
249 269
    Returned value:
250 270
      * 1 - successful
... ...
@@ -252,13 +272,13 @@ ka_add_destination("sip:192.168.1.10:5060;transport=tcp");
252 272
 
253 273
    This function can be used from ANY_ROUTE.
254 274
 
255
-   Example 1.7. ka_del_destination(sip_uri) usage
275
+   Example 1.7. ka_del_destination(sip_uri,owner) usage
256 276
 ...
257 277
 $avp(duri1)="sip:192.168.1.10:5060;transport=tcp";
258 278
 $avp(duri2)="sip:192.168.1.11:5061";
259 279
 $avp(duri3)="sip:192.168.1.12"
260
-ka_del_destination("$avp(duri3)");
261
-ka_del_destination("sip:192.168.1.10:5060;transport=tcp");
280
+ka_del_destination("$avp(duri3)","config");
281
+ka_del_destination("sip:192.168.1.10:5060;transport=tcp","config");
262 282
 ...
263 283
 
264 284
 2.5. RPC Commands