Skip to content

Commit

Permalink
modules: readme files regenerated - keepalive ... [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
kamailio-dev authored and The Root committed May 7, 2020
1 parent 9137f92 commit 5429a0e
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions src/modules/keepalive/README
Expand Up @@ -55,8 +55,8 @@ Yasin CANER

1. Available Functions

1.1. add_destination(uri, owner, flags, [callback,
[user_attr]])
1.1. add_destination(uri, owner, flags, ping_interval,
[callback, [user_attr]])

1.2. Examples

Expand Down Expand Up @@ -324,7 +324,9 @@ Chapter 2. Developer Guide

1. Available Functions

1.1. add_destination(uri, owner, flags, [callback, [user_attr]])
1.1. add_destination(uri, owner, flags, ping_interval, [callback,
[user_attr]])

1.2. Examples

The KeepAlive module provides an internal API to be used by other
Expand All @@ -336,10 +338,13 @@ Chapter 2. Developer Guide

1. Available Functions

1.1. add_destination(uri, owner, flags, [callback, [user_attr]])
1.1. add_destination(uri, owner, flags, ping_interval, [callback,
[user_attr]])

1.2. Examples

1.1. add_destination(uri, owner, flags, [callback, [user_attr]])
1.1. add_destination(uri, owner, flags, ping_interval, [callback,
[user_attr]])

This function registers a new destination to monitor. Monitoring of the
destination starts as soon as it returns with success (0 value).
Expand All @@ -354,6 +359,8 @@ Chapter 2. Developer Guide
* owner (string) - module name “owning” the destination (for
information purpose)
* flags (integer) - destination flags (unused for now, use 0 value)
* ping_interval (integer) - Pinging interval in seconds for this
destination
* callback (ka_statechanged_f, optional) - callback function,
executed on destination's state change.
The callback function is of type void (*ka_statechanged_f)(str
Expand Down Expand Up @@ -398,7 +405,7 @@ void my_callback(str uri, int state, void *user_attr) {
str dest = str_init("sip:192.168.10.21:5060");
str owner = str_init("mymodule");

if (ka_api.add_destination(dest, owner, 0, my_callback, NULL) != 0) {
if (ka_api.add_destination(dest, owner, 0, 60, my_callback, NULL) != 0) {
LM_ERR("can't add destination\n");
goto error;
}
Expand Down

0 comments on commit 5429a0e

Please sign in to comment.