Browse code

modules: readme files regenerated - corex ... [skip ci]

Kamailio Dev authored on 21/05/2020 08:16:22
Showing 1 changed files
... ...
@@ -30,9 +30,9 @@ Muhammad Shahzad Shafi
30 30
         3. Parameters
31 31
 
32 32
               3.1. alias_subdomains (string)
33
-              3.2. network_io_intercept (int)
34
-              3.3. min_msg_len (int)
35
-              3.4. msg_avp (string)
33
+              3.2. nio_intercept (int)
34
+              3.3. nio_min_msg_len (int)
35
+              3.4. nio_msg_avp (string)
36 36
 
37 37
         4. Functions
38 38
 
... ...
@@ -78,9 +78,9 @@ Muhammad Shahzad Shafi
78 78
    List of Examples
79 79
 
80 80
    1.1. Set alias_subdomains parameter
81
-   1.2. Set network_io_intercept parameter
82
-   1.3. Set min_msg_len parameter
83
-   1.4. Set msg_avp parameter
81
+   1.2. Set nio_intercept parameter
82
+   1.3. Set nio_min_msg_len parameter
83
+   1.4. Set nio_msg_avp parameter
84 84
    1.5. append_branch usage
85 85
    1.6. send_udp usage
86 86
    1.7. send_tcp usage
... ...
@@ -120,9 +120,9 @@ Chapter 1. Admin Guide
120 120
    3. Parameters
121 121
 
122 122
         3.1. alias_subdomains (string)
123
-        3.2. network_io_intercept (int)
124
-        3.3. min_msg_len (int)
125
-        3.4. msg_avp (string)
123
+        3.2. nio_intercept (int)
124
+        3.3. nio_min_msg_len (int)
125
+        3.4. nio_msg_avp (string)
126 126
 
127 127
    4. Functions
128 128
 
... ...
@@ -178,14 +178,14 @@ Chapter 1. Admin Guide
178 178
    Contributions to this module must be done under the BSD license, to
179 179
    follow the requirements of the core contributions.
180 180
 
181
-   This module now also provides access to network input / output data
182
-   through event_route[network:msg]. The raw data received from a remote
183
-   host or about to be sent to a remote host is available in variable $mb.
184
-   The script writer may manipulate this data and save the final result in
185
-   an AVP defined by msg_avp module parameter. The content of this AVP
186
-   will then be processed by SIP worker as normal, i.e. a received message
187
-   will be parsed and sent to appropriate route block while a sent message
188
-   is forwarded to remote host.
181
+   This module now also provides access to network input / output (nio)
182
+   data through event_route[network:msg]. The raw data received from a
183
+   remote host or about to be sent to a remote host is available in
184
+   variable $mb. The script writer may manipulate this data and save the
185
+   final result in an AVP defined by msg_avp module parameter. The content
186
+   of this AVP will then be processed by SIP worker as normal, i.e. a
187
+   received message will be parsed and sent to appropriate route block
188
+   while a sent message is forwarded to remote host.
189 189
 
190 190
 2. Dependencies
191 191
 
... ...
@@ -206,9 +206,9 @@ Chapter 1. Admin Guide
206 206
 3. Parameters
207 207
 
208 208
    3.1. alias_subdomains (string)
209
-   3.2. network_io_intercept (int)
210
-   3.3. min_msg_len (int)
211
-   3.4. msg_avp (string)
209
+   3.2. nio_intercept (int)
210
+   3.3. nio_min_msg_len (int)
211
+   3.4. nio_msg_avp (string)
212 212
 
213 213
 3.1. alias_subdomains (string)
214 214
 
... ...
@@ -225,7 +225,7 @@ modparam("corex", "alias_subdomains", "kamailio.org")
225 225
 modparam("corex", "alias_subdomains", "udp:sip-router.org:5060")
226 226
 ...
227 227
 
228
-3.2. network_io_intercept (int)
228
+3.2. nio_intercept (int)
229 229
 
230 230
    If set to non-zero then raw data received from a remote host or about
231 231
    to be sent to a remote host is made available in
... ...
@@ -234,36 +234,36 @@ modparam("corex", "alias_subdomains", "udp:sip-router.org:5060")
234 234
 
235 235
    Default value is 0, i.e. do not allow access to network io data.
236 236
 
237
-   Example 1.2. Set network_io_intercept parameter
237
+   Example 1.2. Set nio_intercept parameter
238 238
 ...
239
-modparam("corex", "network_io_intercept", 1)
239
+modparam("corex", "nio_intercept", 1)
240 240
 ...
241 241
 
242
-3.3. min_msg_len (int)
242
+3.3. nio_min_msg_len (int)
243 243
 
244 244
    Minimum content length of the packet to execute the
245
-   event_route[network:msg]. This only works if network_io_intercept
246
-   parameter is set to non-zero.
245
+   event_route[network:msg]. This only works if nio_intercept parameter is
246
+   set to non-zero.
247 247
 
248 248
    Default value is 0.
249 249
 
250
-   Example 1.3. Set min_msg_len parameter
250
+   Example 1.3. Set nio_min_msg_len parameter
251 251
 ...
252
-modparam("corex", "min_msg_len", 32)
252
+modparam("corex", "nio_min_msg_len", 32)
253 253
 ...
254 254
 
255
-3.4. msg_avp (string)
255
+3.4. nio_msg_avp (string)
256 256
 
257 257
    AVP name to store modified content to be set in the packet. If not set
258 258
    in event_route[network:msg], then all changes are lost and original
259
-   contents are used. This only works if network_io_intercept parameter is
260
-   to set non-zero.
259
+   contents are used. This only works if nio_intercept parameter is to set
260
+   non-zero.
261 261
 
262 262
    Default value is empty.
263 263
 
264
-   Example 1.4. Set msg_avp parameter
264
+   Example 1.4. Set nio_msg_avp parameter
265 265
 ...
266
-modparam("corex", "msg_avp", "$avp(msg)")
266
+modparam("corex", "nio_msg_avp", "$avp(msg)")
267 267
 ...
268 268
 
269 269
 4. Functions
... ...
@@ -383,7 +383,7 @@ s");
383 383
    Returns true if contents of message buffer $mb are the data received
384 384
    from remote host, otherwise false indicating that the contents of $mb
385 385
    are data that is about to be sent out to remote host. This only works
386
-   if network_io_intercept parameter is set to non-zero.
386
+   if nio_intercept parameter is set to non-zero.
387 387
 
388 388
    This function can be used from event_route[network:msg].
389 389
 
... ...
@@ -801,7 +801,7 @@ event_route[dispatcher:dst-down] {
801 801
    messages encrypted by server can be decrypted at client app.
802 802
 
803 803
    Next is a basic usage example where encoding and decoding is done using
804
-   PERL,
804
+   PERL.
805 805
 
806 806
    Example 1.28. event_route[network:msg] use cases
807 807
 ...
... ...
@@ -813,9 +813,9 @@ modparam("app_perl", "filename", "/usr/local/etc/kamailio/custom_compress.pl")
813 813
 modparam("app_perl", "modpath", "/usr/local/lib64/kamailio/perl")
814 814
 
815 815
 # ----- corex params -----
816
-modparam("corex", "network_io_intercept", 32)
817
-modparam("corex", "min_msg_len", 32)
818
-modparam("corex", "msg_avp", "$avp(msg)")
816
+modparam("corex", "nio_intercept", 32)
817
+modparam("corex", "nio_min_msg_len", 32)
818
+modparam("corex", "nio_msg_avp", "$avp(msg)")
819 819
 ...
820 820
 event_route[network:msg] {
821 821
         if (is_incoming()) {