Browse code

modules: readme files regenerated - utils ...

Kamailio Dev authored on 14/01/2017 20:16:17
Showing 1 changed files
... ...
@@ -25,17 +25,13 @@ Carsten Bock
25 25
 
26 26
         3. Parameters
27 27
 
28
-              3.1. http_query_timeout (int)
29
-              3.2. http_response_mode (int)
30
-              3.3. http_response_trim (int)
31
-              3.4. forward_active (int)
32
-              3.5. pres_db_url (string)
33
-              3.6. xcap_table (string)
28
+              3.1. forward_active (int)
29
+              3.2. pres_db_url (string)
30
+              3.3. xcap_table (string)
34 31
 
35 32
         4. Functions
36 33
 
37
-              4.1. http_query(url, [post-data], [header-data], result)
38
-              4.2. xcap_auth_status(watcher_uri, presentity_uri)
34
+              4.1. xcap_auth_status(watcher_uri, presentity_uri)
39 35
 
40 36
         5. MI Commands
41 37
 
... ...
@@ -45,22 +41,17 @@ Carsten Bock
45 41
               5.4. forward_proxy
46 42
 
47 43
         6. Configuration syntax
48
-        7. Remarks
49 44
 
50 45
    List of Examples
51 46
 
52
-   1.1. Set http_query_timeout parameter
53
-   1.2. Set http_response_mode parameter
54
-   1.3. Set http_response_trim parameter
55
-   1.4. Set forward_active parameter
56
-   1.5. Set pres_db_url parameter
57
-   1.6. Set xcap_table parameter
58
-   1.7. http_query() usage
59
-   1.8. xcap_auth_status() usage
60
-   1.9. forward_list usage
61
-   1.10. forward_switch usage
62
-   1.11. forward_filter usage
63
-   1.12. forward_proxy usage
47
+   1.1. Set forward_active parameter
48
+   1.2. Set pres_db_url parameter
49
+   1.3. Set xcap_table parameter
50
+   1.4. xcap_auth_status() usage
51
+   1.5. forward_list usage
52
+   1.6. forward_switch usage
53
+   1.7. forward_filter usage
54
+   1.8. forward_proxy usage
64 55
 
65 56
 Chapter 1. Admin Guide
66 57
 
... ...
@@ -74,17 +65,13 @@ Chapter 1. Admin Guide
74 65
 
75 66
    3. Parameters
76 67
 
77
-        3.1. http_query_timeout (int)
78
-        3.2. http_response_mode (int)
79
-        3.3. http_response_trim (int)
80
-        3.4. forward_active (int)
81
-        3.5. pres_db_url (string)
82
-        3.6. xcap_table (string)
68
+        3.1. forward_active (int)
69
+        3.2. pres_db_url (string)
70
+        3.3. xcap_table (string)
83 71
 
84 72
    4. Functions
85 73
 
86
-        4.1. http_query(url, [post-data], [header-data], result)
87
-        4.2. xcap_auth_status(watcher_uri, presentity_uri)
74
+        4.1. xcap_auth_status(watcher_uri, presentity_uri)
88 75
 
89 76
    5. MI Commands
90 77
 
... ...
@@ -94,16 +81,12 @@ Chapter 1. Admin Guide
94 81
         5.4. forward_proxy
95 82
 
96 83
    6. Configuration syntax
97
-   7. Remarks
98 84
 
99 85
 1. Overview
100 86
 
101 87
    This module implements various utility functions that are not SIP
102 88
    related.
103 89
 
104
-   Function http_query allows Kamailio to issue an HTTP GET request and
105
-   get access to parts of the reply.
106
-
107 90
    The forward functionality allows Kamailio to configure forwarding at
108 91
    runtime with FIFO commands. The forwarding is executed in the pre
109 92
    script call back and therefore handled before the routing script is
... ...
@@ -129,147 +112,54 @@ Chapter 1. Admin Guide
129 112
 
130 113
    The following libraries or applications must be installed before
131 114
    running Kamailio with this module loaded:
132
-     * libcurl.
115
+     * none.
133 116
 
134 117
 3. Parameters
135 118
 
136
-   3.1. http_query_timeout (int)
137
-   3.2. http_response_mode (int)
138
-   3.3. http_response_trim (int)
139
-   3.4. forward_active (int)
140
-   3.5. pres_db_url (string)
141
-   3.6. xcap_table (string)
142
-
143
-3.1. http_query_timeout (int)
144
-
145
-   Defines in seconds how long Kamailio waits for response from HTTP
146
-   server.
147
-
148
-   Default value is zero, i.e., that the http_query_timeout function is
149
-   disabled.
150
-
151
-   Example 1.1. Set http_query_timeout parameter
152
-...
153
-modparam("utils", "http_query_timeout", 2)
154
-...
155
-
156
-3.2. http_response_mode (int)
157
-
158
-   Control what part of the HTTP reponse is returned: only first line (for
159
-   value 0), or all response (for value 1).
160
-
161
-   Default value is 0 (return only the first line).
162
-
163
-   Example 1.2. Set http_response_mode parameter
164
-...
165
-modparam("utils", "http_response_mode", 1)
166
-...
167
-
168
-3.3. http_response_trim (int)
169
-
170
-   Control if white space, tab and end of line characters should be
171
-   trimmed from leading and trailing parts of HTTP response.
172
-
173
-   Default value is 0 (don't trim).
174
-
175
-   Example 1.3. Set http_response_trim parameter
176
-...
177
-modparam("utils", "http_response_trim", 1)
178
-...
119
+   3.1. forward_active (int)
120
+   3.2. pres_db_url (string)
121
+   3.3. xcap_table (string)
179 122
 
180
-3.4. forward_active (int)
123
+3.1. forward_active (int)
181 124
 
182 125
    Defines if the forwarding callback should be installed.
183 126
 
184 127
    Default value is “0” - disabled.
185 128
 
186
-   Example 1.4. Set forward_active parameter
129
+   Example 1.1. Set forward_active parameter
187 130
                                         ...
188 131
                                         modparam("utils", "forward_active", 1)
189 132
                                         ...
190 133
 
191
-3.5. pres_db_url (string)
134
+3.2. pres_db_url (string)
192 135
 
193 136
    Defines presence server database URL. If not given, the
194 137
    xcap_auth_status function is disabled.
195 138
 
196 139
    There is no default value.
197 140
 
198
-   Example 1.5. Set pres_db_url parameter
141
+   Example 1.2. Set pres_db_url parameter
199 142
 ...
200 143
 modparam("utils", "pres_db_url", "mysql://foo:secret@localhost/pres")
201 144
 ...
202 145
 
203
-3.6. xcap_table (string)
146
+3.3. xcap_table (string)
204 147
 
205 148
    Defines the name of the xcap table in the presence server database. See
206 149
    the xcap_server module documentation for more information.
207 150
 
208 151
    Default value is “xcap”.
209 152
 
210
-   Example 1.6. Set xcap_table parameter
153
+   Example 1.3. Set xcap_table parameter
211 154
 ...
212 155
 modparam("utils", "xcap_table", "pres_xcap")
213 156
 ...
214 157
 
215 158
 4. Functions
216 159
 
217
-   4.1. http_query(url, [post-data], [header-data], result)
218
-   4.2. xcap_auth_status(watcher_uri, presentity_uri)
160
+   4.1. xcap_auth_status(watcher_uri, presentity_uri)
219 161
 
220
-4.1.  http_query(url, [post-data], [header-data], result)
221
-
222
-   Sends HTTP GET or POST request according to URL given in “url”
223
-   parameter, which is a string that may contain pseudo variables.
224
-
225
-   If you want to make a POST-Request, you have to define the “post”-data,
226
-   that should be submitted in that request as the second parameter. If
227
-   this parameter is empty, it is not set.
228
-
229
-   If you want to add additional headers to the request, you have to
230
-   define the “header”-data, that should be submitted in that request as
231
-   the third parameter. If this parameter is empty, it is not set.
232
-
233
-   If HTTP server returns a class 2xx, 3xx or 4xx reply, the first line of
234
-   the reply's body (if any) is stored in “result” parameter, which must
235
-   be a writable pseudo variable.
236
-
237
-   Function returns reply code of HTTP reply or -1 if something went
238
-   wrong.
239
-
240
-   This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
241
-   FAILURE_ROUTE, and BRANCH_ROUTE.
242
-
243
-   Example 1.7. http_query() usage
244
-...
245
-# GET-Request
246
-http_query("http://tutpro.com/index.php?r_uri=$(ru{s.escape.param})&f_uri=$(fu{s
247
-.escape.param})",
248
-           "$var(result)");
249
-switch ($retcode) {
250
-       ...
251
-}
252
-...
253
-...
254
-# POST-Request
255
-http_query("http://tutpro.com/index.php", "r_uri=$(ru{s.escape.param})&f_uri=$(f
256
-u{s.escape.param})",
257
-           "$var(result)");
258
-switch ($retcode) {
259
-       ...
260
-}
261
-...
262
-...
263
-# GET-Request with additional headers and Post-Data.
264
-http_query("http://tutpro.com/index.php", "{ "alert": "Alert text goes here" }",
265
- "Content-Type: application/json"
266
-           "$var(result)");
267
-switch ($retcode) {
268
-       ...
269
-}
270
-...
271
-
272
-4.2.  xcap_auth_status(watcher_uri, presentity_uri)
162
+4.1.  xcap_auth_status(watcher_uri, presentity_uri)
273 163
 
274 164
    Function checks in the presence server database if a watcher is
275 165
    authorized to subscribe to event “presence” of presentity. Sphere
... ...
@@ -283,7 +173,7 @@ switch ($retcode) {
283 173
 
284 174
    Function can be used from REQUEST_ROUTE.
285 175
 
286
-   Example 1.8. xcap_auth_status() usage
176
+   Example 1.4. xcap_auth_status() usage
287 177
 ...
288 178
 if (method=="MESSAGE") {
289 179
     xcap_auth_status("$fu", $ru");
... ...
@@ -308,7 +198,7 @@ if (method=="MESSAGE") {
308 198
 
309 199
    No parameters.
310 200
 
311
-   Example 1.9. forward_list usage
201
+   Example 1.5. forward_list usage
312 202
 ...
313 203
 kamctl fifo forward_list
314 204
 id switch                         filter proxy
... ...
@@ -321,7 +211,7 @@ id switch                         filter proxy
321 211
    The syntax of this configuration string is described in 1.6.
322 212
    (switch_setting_list).
323 213
 
324
-   Example 1.10. forward_switch usage
214
+   Example 1.6. forward_switch usage
325 215
 ...
326 216
 kamctl fifo forward_switch 0=on
327 217
 ...
... ...
@@ -340,7 +230,7 @@ kamctl fifo forward_switch 0=on
340 230
    The syntax of this configuration string is described in 1.6.
341 231
    (filter_setting_list).
342 232
 
343
-   Example 1.11. forward_filter usage
233
+   Example 1.7. forward_filter usage
344 234
 ...
345 235
 kamctl fifo forward_filter 0=REGISTER:INVITE
346 236
 ...
... ...
@@ -353,7 +243,7 @@ kamctl fifo forward_filter 0=REGISTER:INVITE
353 243
    switch). The syntax of this configuration string is described in 1.6.
354 244
    (proxy_setting_list).
355 245
 
356
-   Example 1.12. forward_proxy usage
246
+   Example 1.8. forward_proxy usage
357 247
 ...
358 248
 kamctl fifo forward_proxy 0=host-c.domain-c:5060
359 249
 ...
... ...
@@ -379,12 +269,3 @@ kamctl fifo forward_proxy 0=host-c.domain-c:5060
379 269
      * port ::= number
380 270
      * number ::= digit {digit}
381 271
      * digit ::= ? 0-9 ?
382
-
383
-7. Remarks
384
-
385
-   Note: libcurl leak in CentOS 6 - this module uses libcurl library and
386
-   in case if you are using CentOS 6, be aware that standard
387
-   libcurl-7.19.7-52 has a memory leak. To fix this memory, install
388
-   libcurl from city-fan repository. More details at:
389
-   https://www.digitalocean.com/community/questions/how-to-upgrade-curl-in
390
-   -centos6
Browse code

core, lib, modules: restructured source code tree

- new folder src/ to hold the source code for main project applications
- main.c is in src/
- all core files are subfolder are in src/core/
- modules are in src/modules/
- libs are in src/lib/
- application Makefiles are in src/
- application binary is built in src/ (src/kamailio)

Daniel-Constantin Mierla authored on 07/12/2016 11:03:51
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,390 @@
1
+utils
2
+
3
+Juha Heinanen
4
+
5
+   TutPro Inc.
6
+
7
+Carsten Bock
8
+
9
+   ng-voice GmbH
10
+
11
+   Copyright © 2008-2009 Juha Heinanen
12
+
13
+   Copyright © 2013-2015 Carsten Bock, ng-voice GmbH
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
+
26
+        3. Parameters
27
+
28
+              3.1. http_query_timeout (int)
29
+              3.2. http_response_mode (int)
30
+              3.3. http_response_trim (int)
31
+              3.4. forward_active (int)
32
+              3.5. pres_db_url (string)
33
+              3.6. xcap_table (string)
34
+
35
+        4. Functions
36
+
37
+              4.1. http_query(url, [post-data], [header-data], result)
38
+              4.2. xcap_auth_status(watcher_uri, presentity_uri)
39
+
40
+        5. MI Commands
41
+
42
+              5.1. forward_list
43
+              5.2. forward_switch
44
+              5.3. forward_filter
45
+              5.4. forward_proxy
46
+
47
+        6. Configuration syntax
48
+        7. Remarks
49
+
50
+   List of Examples
51
+
52
+   1.1. Set http_query_timeout parameter
53
+   1.2. Set http_response_mode parameter
54
+   1.3. Set http_response_trim parameter
55
+   1.4. Set forward_active parameter
56
+   1.5. Set pres_db_url parameter
57
+   1.6. Set xcap_table parameter
58
+   1.7. http_query() usage
59
+   1.8. xcap_auth_status() usage
60
+   1.9. forward_list usage
61
+   1.10. forward_switch usage
62
+   1.11. forward_filter usage
63
+   1.12. forward_proxy usage
64
+
65
+Chapter 1. Admin Guide
66
+
67
+   Table of Contents
68
+
69
+   1. Overview
70
+   2. Dependencies
71
+
72
+        2.1. Kamailio Modules
73
+        2.2. External Libraries or Applications
74
+
75
+   3. Parameters
76
+
77
+        3.1. http_query_timeout (int)
78
+        3.2. http_response_mode (int)
79
+        3.3. http_response_trim (int)
80
+        3.4. forward_active (int)
81
+        3.5. pres_db_url (string)
82
+        3.6. xcap_table (string)
83
+
84
+   4. Functions
85
+
86
+        4.1. http_query(url, [post-data], [header-data], result)
87
+        4.2. xcap_auth_status(watcher_uri, presentity_uri)
88
+
89
+   5. MI Commands
90
+
91
+        5.1. forward_list
92
+        5.2. forward_switch
93
+        5.3. forward_filter
94
+        5.4. forward_proxy
95
+
96
+   6. Configuration syntax
97
+   7. Remarks
98
+
99
+1. Overview
100
+
101
+   This module implements various utility functions that are not SIP
102
+   related.
103
+
104
+   Function http_query allows Kamailio to issue an HTTP GET request and
105
+   get access to parts of the reply.
106
+
107
+   The forward functionality allows Kamailio to configure forwarding at
108
+   runtime with FIFO commands. The forwarding is executed in the pre
109
+   script call back and therefore handled before the routing script is
110
+   executed on the current message. The callback is not installed on
111
+   default, thus this functionality has no runtime overhead when its
112
+   deactivated.
113
+
114
+   Function xcap_auth_status can be used to check from presence server
115
+   database, if watcher is authorized to subscribe event “presence” of
116
+   presentity.
117
+
118
+2. Dependencies
119
+
120
+   2.1. Kamailio Modules
121
+   2.2. External Libraries or Applications
122
+
123
+2.1. Kamailio Modules
124
+
125
+   The following modules must be loaded before this module:
126
+     * a database module if xcap_auth_status function is enabled.
127
+
128
+2.2. External Libraries or Applications
129
+
130
+   The following libraries or applications must be installed before
131
+   running Kamailio with this module loaded:
132
+     * libcurl.
133
+
134
+3. Parameters
135
+
136
+   3.1. http_query_timeout (int)
137
+   3.2. http_response_mode (int)
138
+   3.3. http_response_trim (int)
139
+   3.4. forward_active (int)
140
+   3.5. pres_db_url (string)
141
+   3.6. xcap_table (string)
142
+
143
+3.1. http_query_timeout (int)
144
+
145
+   Defines in seconds how long Kamailio waits for response from HTTP
146
+   server.
147
+
148
+   Default value is zero, i.e., that the http_query_timeout function is
149
+   disabled.
150
+
151
+   Example 1.1. Set http_query_timeout parameter
152
+...
153
+modparam("utils", "http_query_timeout", 2)
154
+...
155
+
156
+3.2. http_response_mode (int)
157
+
158
+   Control what part of the HTTP reponse is returned: only first line (for
159
+   value 0), or all response (for value 1).
160
+
161
+   Default value is 0 (return only the first line).
162
+
163
+   Example 1.2. Set http_response_mode parameter
164
+...
165
+modparam("utils", "http_response_mode", 1)
166
+...
167
+
168
+3.3. http_response_trim (int)
169
+
170
+   Control if white space, tab and end of line characters should be
171
+   trimmed from leading and trailing parts of HTTP response.
172
+
173
+   Default value is 0 (don't trim).
174
+
175
+   Example 1.3. Set http_response_trim parameter
176
+...
177
+modparam("utils", "http_response_trim", 1)
178
+...
179
+
180
+3.4. forward_active (int)
181
+
182
+   Defines if the forwarding callback should be installed.
183
+
184
+   Default value is “0” - disabled.
185
+
186
+   Example 1.4. Set forward_active parameter
187
+                                        ...
188
+                                        modparam("utils", "forward_active", 1)
189
+                                        ...
190
+
191
+3.5. pres_db_url (string)
192
+
193
+   Defines presence server database URL. If not given, the
194
+   xcap_auth_status function is disabled.
195
+
196
+   There is no default value.
197
+
198
+   Example 1.5. Set pres_db_url parameter
199
+...
200
+modparam("utils", "pres_db_url", "mysql://foo:secret@localhost/pres")
201
+...
202
+
203
+3.6. xcap_table (string)
204
+
205
+   Defines the name of the xcap table in the presence server database. See
206
+   the xcap_server module documentation for more information.
207
+
208
+   Default value is “xcap”.
209
+
210
+   Example 1.6. Set xcap_table parameter
211
+...
212
+modparam("utils", "xcap_table", "pres_xcap")
213
+...
214
+
215
+4. Functions
216
+
217
+   4.1. http_query(url, [post-data], [header-data], result)
218
+   4.2. xcap_auth_status(watcher_uri, presentity_uri)
219
+
220
+4.1.  http_query(url, [post-data], [header-data], result)
221
+
222
+   Sends HTTP GET or POST request according to URL given in “url”
223
+   parameter, which is a string that may contain pseudo variables.
224
+
225
+   If you want to make a POST-Request, you have to define the “post”-data,
226
+   that should be submitted in that request as the second parameter. If
227
+   this parameter is empty, it is not set.
228
+
229
+   If you want to add additional headers to the request, you have to
230
+   define the “header”-data, that should be submitted in that request as
231
+   the third parameter. If this parameter is empty, it is not set.
232
+
233
+   If HTTP server returns a class 2xx, 3xx or 4xx reply, the first line of
234
+   the reply's body (if any) is stored in “result” parameter, which must
235
+   be a writable pseudo variable.
236
+
237
+   Function returns reply code of HTTP reply or -1 if something went
238
+   wrong.
239
+
240
+   This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
241
+   FAILURE_ROUTE, and BRANCH_ROUTE.
242
+
243
+   Example 1.7. http_query() usage
244
+...
245
+# GET-Request
246
+http_query("http://tutpro.com/index.php?r_uri=$(ru{s.escape.param})&f_uri=$(fu{s
247
+.escape.param})",
248
+           "$var(result)");
249
+switch ($retcode) {
250
+       ...
251
+}
252
+...
253
+...
254
+# POST-Request
255
+http_query("http://tutpro.com/index.php", "r_uri=$(ru{s.escape.param})&f_uri=$(f
256
+u{s.escape.param})",
257
+           "$var(result)");
258
+switch ($retcode) {
259
+       ...
260
+}
261
+...
262
+...
263
+# GET-Request with additional headers and Post-Data.
264
+http_query("http://tutpro.com/index.php", "{ "alert": "Alert text goes here" }",
265
+ "Content-Type: application/json"
266
+           "$var(result)");
267
+switch ($retcode) {
268
+       ...
269
+}
270
+...
271
+
272
+4.2.  xcap_auth_status(watcher_uri, presentity_uri)
273
+
274
+   Function checks in the presence server database if a watcher is
275
+   authorized to subscribe to event “presence” of presentity. Sphere
276
+   checking is not included.
277
+
278
+   Both watcher_uri and presentity_uri are pseudo variables. The function
279
+   returns ACTIVE_STATUS, if a subscription is allowed and PENDING_STATUS,
280
+   TERMINATED_STATUS, or WAITING_STATUS otherwise. See
281
+   presence/subscribe.h for the corresponding integer codes. In case of
282
+   error, function returns -1.
283
+
284
+   Function can be used from REQUEST_ROUTE.
285
+
286
+   Example 1.8. xcap_auth_status() usage
287
+...
288
+if (method=="MESSAGE") {
289
+    xcap_auth_status("$fu", $ru");
290
+    if ($retcode == 1) {
291
+        t_relay();
292
+    } else {
293
+        send_reply("403", "Forbidden");
294
+    }
295
+}
296
+...
297
+
298
+5. MI Commands
299
+
300
+   5.1. forward_list
301
+   5.2. forward_switch
302
+   5.3. forward_filter
303
+   5.4. forward_proxy
304
+
305
+5.1. forward_list
306
+
307
+   List active forward rules.
308
+
309
+   No parameters.
310
+
311
+   Example 1.9. forward_list usage
312
+...
313
+kamctl fifo forward_list
314
+id switch                         filter proxy
315
+ 0    off      REGISTER:INVITE:SUBSCRIBE host-a.domain-a:5060
316
+...
317
+
318
+5.2. forward_switch
319
+
320
+   This command can be used to activate or deactivate forwarding rules.
321
+   The syntax of this configuration string is described in 1.6.
322
+   (switch_setting_list).
323
+
324
+   Example 1.10. forward_switch usage
325
+...
326
+kamctl fifo forward_switch 0=on
327
+...
328
+
329
+5.3. forward_filter
330
+
331
+   Can be used to specify the filter for a certain id. Messages will only
332
+   be forwarded if one of the filters matches the message.
333
+
334
+   There are special filters and regular filters. Special filters are:
335
+     * REQUEST (matches on every request)
336
+     * REPLY (matches on every reply)
337
+
338
+   Regular filters are arbitrary strings not containing the delimiter ':'.
339
+   They are matched against the request method names of the sip messages.
340
+   The syntax of this configuration string is described in 1.6.
341
+   (filter_setting_list).
342
+
343
+   Example 1.11. forward_filter usage
344
+...
345
+kamctl fifo forward_filter 0=REGISTER:INVITE
346
+...
347
+
348
+5.4. forward_proxy
349
+
350
+   This command can be used to configure forwarding rules. Specifies the
351
+   destination for a certain id. Messages will be forwarded to this
352
+   destination if the preconditions hold (matching id, filter, and
353
+   switch). The syntax of this configuration string is described in 1.6.
354
+   (proxy_setting_list).
355
+
356
+   Example 1.12. forward_proxy usage
357
+...
358
+kamctl fifo forward_proxy 0=host-c.domain-c:5060
359
+...
360
+
361
+6. Configuration syntax
362
+
363
+   This grammar specify the usable configuration syntax
364
+     * switch_setting_list ::= switch_setting { "," switch_setting }
365
+     * filter_setting_list ::= switch_setting { "," switch_setting }
366
+     * proxy_setting_list ::= proxy_setting { "," proxy_setting }
367
+     * switch_setting ::= id "=" switch
368
+     * filter_setting ::= id "=" filter_list
369
+     * proxy_setting ::= id "=" proxy
370
+     * switch ::= ( "off" | "on" )
371
+     * filter_list ::= filter { ":" filter }
372
+     * proxy ::= host ":" port
373
+     * filter ::= ( special_filter | regular_filter )
374
+     * special_filter ::= ( "REQUEST" | "REPLY" )
375
+     * regular_filter ::= ? [^:]* ?
376
+     * host ::= char { char }
377
+     * char ::= ? A-Za-z0-9.-_ ?
378
+     * id ::= number
379
+     * port ::= number
380
+     * number ::= digit {digit}
381
+     * digit ::= ? 0-9 ?
382
+
383
+7. Remarks
384
+
385
+   Note: libcurl leak in CentOS 6 - this module uses libcurl library and
386
+   in case if you are using CentOS 6, be aware that standard
387
+   libcurl-7.19.7-52 has a memory leak. To fix this memory, install
388
+   libcurl from city-fan repository. More details at:
389
+   https://www.digitalocean.com/community/questions/how-to-upgrade-curl-in
390
+   -centos6