git.sip-router.org Git - sip-router/blob - 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. The monitoring is done by sending SIP
  62    OPTIONS requests, more or less in the same fashion as the dispatcher
  63    module (which was the initial source for this module).
  64
  65    As an example of usage by other modules, see drouting, which was
  66    enahnced to use this module to monitor its gateways.
  67
  68 2. Dependencies
  69
  70    2.1. Kamailio Modules
  71    2.2. External Libraries or Applications
  72    2.3. Parameters
  73
  74         2.3.1. ping_interval (integer)
  75         2.3.2. destination (string)
  76
  77    2.4. Functions
  78
  79         2.4.1. is_alive(destination)
  80
  81 2.1. Kamailio Modules
  82
  83    The following modules must be loaded before this module:
  84      * tm - Transaction module
  85
  86 2.2. External Libraries or Applications
  87
  88    The following libraries or applications must be installed before
  89    running Kamailio with this module loaded:
  90      * none
  91
  92 2.3. Parameters
  93
  94 2.3.1. ping_interval (integer)
  95
  96    Interval requests are sent to destinations (in seconds)
  97
  98    Default value is 30 seconds.
  99
 100    Example 1.1. Set ping_interval parameter
 101 ...
 102 modparam("keepalive", "ping_interval", 10)
 103 ...
 104
 105 2.3.2. destination (string)
 106
 107    Allows to specify statically destinations you want to monitor
 108
 109    Example 1.2. Set destination parameter
 110 ...
 111 modparam("keepalive", "destination", "192.168.10.20")
 112 modparam("keepalive", "destination", "sip.provider.com")
 113 ...
 114
 115 2.4. Functions
 116
 117 2.4.1.  is_alive(destination)
 118
 119    Get destination status
 120
 121    Parameter “destination” is destination you want to check status
 122
 123    Return value: 1 if destination is up, 2 if destination is down, -1 on
 124    error.
 125
 126    This function can be used from ANY_ROUTE.
 127
 128    Example 1.3. is_alive() usage
 129 ...
 130 is_alive("192.168.10.20");
 131 ...