git.sip-router.org Git - sip-router/blob - src/modules/evrexec/README

   1 EvRExec Module
   2
   3 Daniel-Constantin Mierla
   4
   5    asipto.com
   6    <miconda@gmail.com>
   7
   8 Edited by
   9
  10 Daniel-Constantin Mierla
  11
  12    <miconda@gmail.com>
  13
  14    Copyright © 2017 http://www.asipto.com
  15      __________________________________________________________________
  16
  17    Table of Contents
  18
  19    1. Admin Guide
  20
  21         1. Overview
  22         2. Dependencies
  23
  24               2.1. Kamailio Modules
  25               2.2. External Libraries or Applications
  26
  27         3. Parameters
  28
  29               3.1. exec (str)
  30
  31    List of Examples
  32
  33    1.1. Set exec parameter
  34
  35 Chapter 1. Admin Guide
  36
  37    Table of Contents
  38
  39    1. Overview
  40    2. Dependencies
  41
  42         2.1. Kamailio Modules
  43         2.2. External Libraries or Applications
  44
  45    3. Parameters
  46
  47         3.1. exec (str)
  48
  49 1. Overview
  50
  51    The module executes even route blocks once on dedicated processes. The
  52    execution can be delayed for an interval of time.
  53
  54    The actions in the event route should be a loop or other tasks that run
  55    forever.
  56
  57 2. Dependencies
  58
  59    2.1. Kamailio Modules
  60    2.2. External Libraries or Applications
  61
  62 2.1. Kamailio Modules
  63
  64    The following modules must be loaded before this module:
  65      * No dependencies on other Kamailio modules.
  66
  67 2.2. External Libraries or Applications
  68
  69    The following libraries or applications must be installed before
  70    running Kamailio with this module loaded:
  71      * None.
  72
  73 3. Parameters
  74
  75    3.1. exec (str)
  76
  77 3.1. exec (str)
  78
  79    The definition of an exec task. The value of the parameter must have
  80    the following format:
  81      * "name=_string_;wait=_number_;workers=_number_"
  82
  83    The parameter can be set multiple times to get more exec tasks in same
  84    configuration file.
  85      * name - name of the event route to be executed.
  86      * workers - if set to 0 or 1 the task is executed in a dedicated
  87        process. Any number > 1 will create more dedicated processes, each
  88        of them executing the task.
  89      * wait - timer interval in micro-seconds to wait inside the dedicated
  90        process before executing the task.
  91
  92    Default value is NULL.
  93
  94    Example 1.1. Set exec parameter
  95 ...
  96 modparam("evrexec", "exec", "name=evrexec:timer;wait=1000;workers=1;")
  97 ...
  98 event_route[evrexec:timer] {
  99   $var(x) = 0;
 100   while(1) {
 101     xlog("$$var(x) is $var(x)\n");
 102     $var(x) = $var(x) + 1;
 103     sleep("600");
 104   }
 105 }
 106 ...