6bfc95040e215ff3826cbb713464dd9b9b0a19cf
[sip-router] / src / modules / keepalive / README
1 KeepAlive Module
2
3 Guillaume Bour
4
5    <guillaume@bour.cc>
6
7 Edited by
8
9 Guillaume Bour
10
11    <guillaume@bour.cc>
12
13    Copyright © 2017 Guillaume Bour
14      __________________________________________________________________
15
16    Table of Contents
17
18    1. Admin Guide
19
20         1. Overview
21         2. Dependencies
22
23               2.1. Kamailio Modules
24               2.2. External Libraries or Applications
25               2.3. Parameters
26
27                     2.3.1. ping_interval (integer)
28                     2.3.2. destination (string)
29
30               2.4. Functions
31
32                     2.4.1. is_alive(destination)
33
34    List of Examples
35
36    1.1. Set ping_interval parameter
37    1.2. Set destination parameter
38    1.3. is_alive() usage
39
40 Chapter 1. Admin Guide
41
42    Table of Contents
43
44    1. Overview
45    2. Dependencies
46
47         2.1. Kamailio Modules
48         2.2. External Libraries or Applications
49         2.3. Parameters
50
51               2.3.1. ping_interval (integer)
52               2.3.2. destination (string)
53
54         2.4. Functions
55
56               2.4.1. is_alive(destination)
57
58 1. Overview
59
60    This module performs destinations monitoring either for itself, or on
61    the behalf of other modules
62
63 2. Dependencies
64
65    2.1. Kamailio Modules
66    2.2. External Libraries or Applications
67    2.3. Parameters
68
69         2.3.1. ping_interval (integer)
70         2.3.2. destination (string)
71
72    2.4. Functions
73
74         2.4.1. is_alive(destination)
75
76 2.1. Kamailio Modules
77
78    The following modules must be loaded before this module:
79      * tm - Transaction module
80
81 2.2. External Libraries or Applications
82
83    The following libraries or applications must be installed before
84    running Kamailio with this module loaded:
85      * none
86
87 2.3. Parameters
88
89 2.3.1. ping_interval (integer)
90
91    Interval requests are sent to destinations (in seconds)
92
93    Default value is 30 seconds.
94
95    Example 1.1. Set ping_interval parameter
96 ...
97 modparam("keepalive", "ping_interval", 10)
98 ...
99
100 2.3.2. destination (string)
101
102    Allows to specify statically destinations you want to monitor
103
104    Example 1.2. Set destination parameter
105 ...
106 modparam("keepalive", "destination", "192.168.10.20")
107 modparam("keepalive", "destination", "sip.provider.com")
108 ...
109
110 2.4. Functions
111
112 2.4.1.  is_alive(destination)
113
114    Get destination status
115
116    Parameter “destination” is destination you want to check status
117
118    Return value: 1 if destination is up, 2 if destination is down, -1 on
119    error.
120
121    This function can be used from ANY_ROUTE.
122
123    Example 1.3. is_alive() usage
124 ...
125 is_alive("192.168.10.20");
126 ...