/usr/share/doc/kamailio/modules/README.rtimer is in kamailio 4.0.4-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 | RTimer Module
Daniel-Constantin Mierla
asipto.com
<miconda@gmail.com>
Edited by
Daniel-Constantin Mierla
<miconda@gmail.com>
Copyright © 2009 http://www.asipto.com
__________________________________________________________________
Table of Contents
1. Admin Guide
1. Overview
2. Dependencies
2.1. Kamailio Modules
2.2. External Libraries or Applications
3. Parameters
3.1. timer (str)
3.2. exec (str)
List of Examples
1.1. Set timer parameter
1.2. Set exec parameter
Chapter 1. Admin Guide
Table of Contents
1. Overview
2. Dependencies
2.1. Kamailio Modules
2.2. External Libraries or Applications
3. Parameters
3.1. timer (str)
3.2. exec (str)
1. Overview
The module executes route blocks on a timer base. It can create new
timer processes and execute many route blocks on same timer.
A static faked SIP message is given as parameter to called functions,
so all functions available for REQUEST_ROUTE can be used.
2. Dependencies
2.1. Kamailio Modules
2.2. External Libraries or Applications
2.1. Kamailio Modules
The following modules must be loaded before this module:
* No dependencies on other Kamailio modules.
2.2. External Libraries or Applications
The following libraries or applications must be installed before
running Kamailio with this module loaded:
* None.
3. Parameters
3.1. timer (str)
3.2. exec (str)
3.1. timer (str)
The definition of a timer. The value of the parameter must have the
following format:
* "name=_string_;mode=_number_;interval=_number_"
The parameter can be set multiple times to get more timers in same
configuration file.
* name - name of the timer.
* mode - if set to 1, will create a new timer process.
* interval - timer interval in seconds or micro-seconds (the value
must be ended in 'u'). For micro-seconds intervals, mode is set
always to 1.
Default value is NULL.
Example 1.1. Set timer parameter
...
# time interval set to 10 seconds
modparam("rtimer", "timer", "name=ta;interval=10;mode=1;")
# time interval set to 100 mili-seconds
modparam("rtimer", "timer", "name=ta;interval=100000u;mode=1;")
...
3.2. exec (str)
Specify route to be executed on timer. The value of the parameter must
have the following format:
* "timer=_string_;route=_number_"
The parameter can be set multiple times to get more routes executed on
same timer.
* timer - name of the timer.
* route - the index of the route to be executed.
Default value is NULL.
Example 1.2. Set exec parameter
...
modparam("rtimer", "timer", "name=ta;interval=10;mode=1;")
modparam("rtimer", "exec", "timer=ta;route=8")
route[8] {
xlog("timer routine: time is %TF\n");
# delete from my sql cache table entries older than 2H
sql_query("delete from kamailio_cache where last_updated<$TS-3600");
}
...
|