Debian Codegraph @

src/modules/call_obj/README

raw
1 CALL_OBJ Module
2
3 Vicente Hernando
4
5 <[email protected]>
6
7 Edited by
8
9 Vicente Hernando
10
11 <[email protected]>
12
13 Javier Gallart
14
15 <[email protected]>
16
17 Copyright © 2016 www.systemonenoc.com
18 __________________________________________________________________
19
20 Table of Contents
21
22 1. Admin Guide
23
24 1. Overview
25 2. Dependencies
26
27 2.1. Kamailio Modules
28 2.2. External Libraries or Applications
29
30 3. Parameters
31
32 3.1. start (integer)
33 3.2. end (integer)
34
35 4. Functions
36
37 4.1. call_obj_get(reply_number)
38 4.2. call_obj_free(object_number)
39
40 5. RPC Commands
41
42 5.1. call_obj.free
43 5.2. call_obj.stats
44 5.3. call_obj.free_all
45 5.4. call_obj.list
46
47 List of Examples
48
49 1.1. Set start parameter
50 1.2. Set end parameter
51 1.3. call_obj_get usage
52 1.4. call_obj_free usage
53 1.5. call_obj.free usage
54 1.6. call_obj.stats usage
55 1.7. call_obj.free_all usage
56 1.8. call_obj.list usage
57
58 Chapter 1. Admin Guide
59
60 Table of Contents
61
62 1. Overview
63 2. Dependencies
64
65 2.1. Kamailio Modules
66 2.2. External Libraries or Applications
67
68 3. Parameters
69
70 3.1. start (integer)
71 3.2. end (integer)
72
73 4. Functions
74
75 4.1. call_obj_get(reply_number)
76 4.2. call_obj_free(object_number)
77
78 5. RPC Commands
79
80 5.1. call_obj.free
81 5.2. call_obj.stats
82 5.3. call_obj.free_all
83 5.4. call_obj.list
84
85 1. Overview
86
87 This module provides a way to identify calls using an increasing
88 sequence of integers.
89
90 It starts assigning an integer to a call. Next call gets next free
91 integer in a ring. When a call finishes its assigned number shall be
92 freed.
93
94 2. Dependencies
95
96 2.1. Kamailio Modules
97 2.2. External Libraries or Applications
98
99 2.1. Kamailio Modules
100
101 The following modules must be loaded before this module:
102 * none.
103
104 2.2. External Libraries or Applications
105
106 The following libraries or applications must be installed before
107 running Kamailio with this module loaded:
108 * None.
109
110 3. Parameters
111
112 3.1. start (integer)
113 3.2. end (integer)
114
115 3.1. start (integer)
116
117 First number to assign when no number has been assigned yet.
118
119 This parameter has no default value. Not setting it raises an error.
120
121 Its value shall be greater than zero.
122
123 Example 1.1. Set start parameter
124 ...
125 modparam("call_obj", "start", 10)
126 ...
127
128 3.2. end (integer)
129
130 Last number to assign when all other numbers have been already
131 assigned.
132
133 No default value. Not setting this parameter raises an error.
134
135 Its value shall be greater than zero.
136
137 Example 1.2. Set end parameter
138 ...
139 modparam("call_obj", "end", 93)
140 ...
141
142 4. Functions
143
144 4.1. call_obj_get(reply_number)
145 4.2. call_obj_free(object_number)
146
147 4.1. call_obj_get(reply_number)
148
149 Get next free number. reply_number parameter is a variable where
150 function will store result in string format.
151
152 Example 1.3. call_obj_get usage
153 ...
154 if (call_obj_get("$dlg_var(x)")) {
155 xlog("Object: $dlg_var(x)\n");
156 }
157 ...
158
159 4.2. call_obj_free(object_number)
160
161 Mark an object_number as free, so it can be assigned again. This number
162 will not be readily assigned until a loop in the ring has completed.
163 object_number shall be provided in string format.
164
165 Example 1.4. call_obj_free usage
166 ...
167 $dlg_var(y) = "27";
168 if (call_obj_free("$dlg_var(y)")) {
169 xlog("object $dlg_var(y) freed OK\n");
170 }
171 ...
172
173 5. RPC Commands
174
175 5.1. call_obj.free
176 5.2. call_obj.stats
177 5.3. call_obj.free_all
178 5.4. call_obj.list
179
180 5.1. call_obj.free
181
182 Free an object.
183
184 Parameter is a number represented in string format.
185
186 Name: call_obj.free
187
188 Parameters: object_number
189
190 Example 1.5. call_obj.free usage
191 ...
192 kamcmd call_obj.free s:12
193 ...
194
195 5.2. call_obj.stats
196
197 Return some statistics about call_obj module.
198
199 It currently returns:
200 * Start: Number of first object
201 * End: Number of last object in range
202 * Total: Total assignable objects
203 * Assigned: Number of currently assigned objects
204
205 Name: call_obj.stats
206
207 Parameters: none
208
209 Example 1.6. call_obj.stats usage
210 ...
211 kamcmd call_obj.stats
212 ...
213
214 5.3. call_obj.free_all
215
216 Make all objects free at once.
217
218 Name: call_obj.free_all
219
220 Parameters: none
221
222 Example 1.7. call_obj.free_all usage
223 ...
224 kamcmd call_obj.free_all
225 ...
226
227 5.4. call_obj.list
228
229 List all active calls which duration is longer than a value in seconds.
230
231 Name: call_obj.list
232
233 Parameters: duration limit
234
235 limit parameter is optional
236
237 Example 1.8. call_obj.list usage
238 ...
239 Show every call which duration is less than or equal to 24 seconds:
240 kamcmd call_obj.list 24
241
242 Same but limit output to at most 5 calls:
243 kamcmd call_obj.list 24 5
244
245 Same but show again all calls (0 means no limit):
246 kamcmd call_obj.list 24 0
247 ...