Browse code

modules_k/registrar: Removed tcp_persistent_flag module parameter.

- Commented out tcp_persistent_flag module parameter, because sr_3.0 tm
does not support it.
- Removed the flags also from module README.

Juha Heinanen authored on 09/12/2009 08:19:54
Showing 3 changed files
... ...
@@ -40,22 +40,21 @@ Bogdan-Andre Iancu
40 40
               3.2. min_expires (integer)
41 41
               3.3. max_expires (integer)
42 42
               3.4. default_q (integer)
43
-              3.5. tcp_persistent_flag (integer)
44
-              3.6. realm_prefix (string)
45
-              3.7. append_branches (integer)
46
-              3.8. aor_avp (str)
47
-              3.9. case_sensitive (integer)
48
-              3.10. received_avp (str)
49
-              3.11. received_param (string)
50
-              3.12. max_contacts (integer)
51
-              3.13. retry_after (integer)
52
-              3.14. sock_flag (integer)
53
-              3.15. sock_hdr_name (string)
54
-              3.16. method_filtering (integer)
55
-              3.17. use_path (integer)
56
-              3.18. path_mode (integer)
57
-              3.19. path_use_received (integer)
58
-              3.20. reg_callid_avp (string)
43
+              3.5. realm_prefix (string)
44
+              3.6. append_branches (integer)
45
+              3.7. aor_avp (str)
46
+              3.8. case_sensitive (integer)
47
+              3.9. received_avp (str)
48
+              3.10. received_param (string)
49
+              3.11. max_contacts (integer)
50
+              3.12. retry_after (integer)
51
+              3.13. sock_flag (integer)
52
+              3.14. sock_hdr_name (string)
53
+              3.15. method_filtering (integer)
54
+              3.16. use_path (integer)
55
+              3.17. path_mode (integer)
56
+              3.18. path_use_received (integer)
57
+              3.19. reg_callid_avp (string)
59 58
 
60 59
         4. Exported Functions
61 60
 
... ...
@@ -88,31 +87,30 @@ Bogdan-Andre Iancu
88 87
    1.2. Set min_expires parameter
89 88
    1.3. Set max_expires parameter
90 89
    1.4. Set default_q parameter
91
-   1.5. Set tcp_persistent_flag parameter
92
-   1.6. Set realm_prefix parameter
93
-   1.7. Set append_branches parameter
94
-   1.8. Set aor_avp parameter
95
-   1.9. Set case_sensitive parameter
96
-   1.10. Set received_avp parameter
97
-   1.11. Set received_param parameter
98
-   1.12. Set max_contacts parameter
99
-   1.13. Set retry_after parameter
100
-   1.14. Set sock_flag parameter
101
-   1.15. Set sock_hdr_namer parameter
102
-   1.16. Set method_filtering parameter
103
-   1.17. Set use_path parameter
104
-   1.18. Set path_mode parameter
105
-   1.19. Set path_use_received parameter
106
-   1.20. Set reg_callid_avp parameter
90
+   1.5. Set realm_prefix parameter
91
+   1.6. Set append_branches parameter
92
+   1.7. Set aor_avp parameter
93
+   1.8. Set case_sensitive parameter
94
+   1.9. Set received_avp parameter
95
+   1.10. Set received_param parameter
96
+   1.11. Set max_contacts parameter
97
+   1.12. Set retry_after parameter
98
+   1.13. Set sock_flag parameter
99
+   1.14. Set sock_hdr_namer parameter
100
+   1.15. Set method_filtering parameter
101
+   1.16. Set use_path parameter
102
+   1.17. Set path_mode parameter
103
+   1.18. Set path_use_received parameter
104
+   1.19. Set reg_callid_avp parameter
105
+   1.20. save usage
107 106
    1.21. save usage
108
-   1.22. save usage
109
-   1.23. lookup usage
110
-   1.24. registered usage
111
-   1.25. add_sock_hdr usage
107
+   1.22. lookup usage
108
+   1.23. registered usage
109
+   1.24. add_sock_hdr usage
110
+   1.25. registered usage
112 111
    1.26. registered usage
113 112
    1.27. registered usage
114
-   1.28. registered usage
115
-   1.29. $sht(name) usage
113
+   1.28. $sht(name) usage
116 114
 
117 115
 Chapter 1. Admin Guide
118 116
 
... ...
@@ -133,22 +131,21 @@ Chapter 1. Admin Guide
133 131
         3.2. min_expires (integer)
134 132
         3.3. max_expires (integer)
135 133
         3.4. default_q (integer)
136
-        3.5. tcp_persistent_flag (integer)
137
-        3.6. realm_prefix (string)
138
-        3.7. append_branches (integer)
139
-        3.8. aor_avp (str)
140
-        3.9. case_sensitive (integer)
141
-        3.10. received_avp (str)
142
-        3.11. received_param (string)
143
-        3.12. max_contacts (integer)
144
-        3.13. retry_after (integer)
145
-        3.14. sock_flag (integer)
146
-        3.15. sock_hdr_name (string)
147
-        3.16. method_filtering (integer)
148
-        3.17. use_path (integer)
149
-        3.18. path_mode (integer)
150
-        3.19. path_use_received (integer)
151
-        3.20. reg_callid_avp (string)
134
+        3.5. realm_prefix (string)
135
+        3.6. append_branches (integer)
136
+        3.7. aor_avp (str)
137
+        3.8. case_sensitive (integer)
138
+        3.9. received_avp (str)
139
+        3.10. received_param (string)
140
+        3.11. max_contacts (integer)
141
+        3.12. retry_after (integer)
142
+        3.13. sock_flag (integer)
143
+        3.14. sock_hdr_name (string)
144
+        3.15. method_filtering (integer)
145
+        3.16. use_path (integer)
146
+        3.17. path_mode (integer)
147
+        3.18. path_use_received (integer)
148
+        3.19. reg_callid_avp (string)
152 149
 
153 150
    4. Exported Functions
154 151
 
... ...
@@ -230,22 +227,21 @@ Chapter 1. Admin Guide
230 227
    3.2. min_expires (integer)
231 228
    3.3. max_expires (integer)
232 229
    3.4. default_q (integer)
233
-   3.5. tcp_persistent_flag (integer)
234
-   3.6. realm_prefix (string)
235
-   3.7. append_branches (integer)
236
-   3.8. aor_avp (str)
237
-   3.9. case_sensitive (integer)
238
-   3.10. received_avp (str)
239
-   3.11. received_param (string)
240
-   3.12. max_contacts (integer)
241
-   3.13. retry_after (integer)
242
-   3.14. sock_flag (integer)
243
-   3.15. sock_hdr_name (string)
244
-   3.16. method_filtering (integer)
245
-   3.17. use_path (integer)
246
-   3.18. path_mode (integer)
247
-   3.19. path_use_received (integer)
248
-   3.20. reg_callid_avp (string)
230
+   3.5. realm_prefix (string)
231
+   3.6. append_branches (integer)
232
+   3.7. aor_avp (str)
233
+   3.8. case_sensitive (integer)
234
+   3.9. received_avp (str)
235
+   3.10. received_param (string)
236
+   3.11. max_contacts (integer)
237
+   3.12. retry_after (integer)
238
+   3.13. sock_flag (integer)
239
+   3.14. sock_hdr_name (string)
240
+   3.15. method_filtering (integer)
241
+   3.16. use_path (integer)
242
+   3.17. path_mode (integer)
243
+   3.18. path_use_received (integer)
244
+   3.19. reg_callid_avp (string)
249 245
 
250 246
 3.1. default_expires (integer)
251 247
 
... ...
@@ -301,23 +297,7 @@ modparam("registrar", "max_expires", 120)
301 297
 modparam("registrar", "default_q", 1000)
302 298
 ...
303 299
 
304
-3.5. tcp_persistent_flag (integer)
305
-
306
-   The parameter specifies the message flag to be used to control the
307
-   module behaviour regarding TCP connections. If the flag is set for a
308
-   REGISTER via TCP containing a TCP contact, the module, via the "save()"
309
-   functions will set the lifetime of the TCP connection to the contact
310
-   expire value. By doing this, the TCP connection will stay on as long as
311
-   the contact is valid.
312
-
313
-   Default value is -1 (disabled).
314
-
315
-   Example 1.5. Set tcp_persistent_flag parameter
316
-...
317
-modparam("registrar", "tcp_persistent_flag", 7)
318
-...
319
-
320
-3.6. realm_prefix (string)
300
+3.5. realm_prefix (string)
321 301
 
322 302
    Prefix to be automatically strip from realm. As an alternative to SRV
323 303
    records (not all SIP clients support SRV lookup), a subdomain of the
... ...
@@ -328,12 +308,12 @@ modparam("registrar", "tcp_persistent_flag", 7)
328 308
 
329 309
    Default value is NULL (none).
330 310
 
331
-   Example 1.6. Set realm_prefix parameter
311
+   Example 1.5. Set realm_prefix parameter
332 312
 ...
333 313
 modparam("registrar", "realm_prefix", "sip.")
334 314
 ...
335 315
 
336
-3.7. append_branches (integer)
316
+3.6. append_branches (integer)
337 317
 
338 318
    The parameter controls how lookup function processes multiple contacts.
339 319
    If there are multiple contacts for the given username in usrloc and
... ...
@@ -345,12 +325,12 @@ modparam("registrar", "realm_prefix", "sip.")
345 325
 
346 326
    Default value is 1.
347 327
 
348
-   Example 1.7. Set append_branches parameter
328
+   Example 1.6. Set append_branches parameter
349 329
 ...
350 330
 modparam("registrar", "append_branches", 0)
351 331
 ...
352 332
 
353
-3.8. aor_avp (str)
333
+3.7. aor_avp (str)
354 334
 
355 335
    If set, the module will try first to get the AOR from this AVP instead
356 336
    of fetching it form the processed request.
... ...
@@ -360,24 +340,24 @@ modparam("registrar", "append_branches", 0)
360 340
 
361 341
    Default value is "NULL" (disabled).
362 342
 
363
-   Example 1.8. Set aor_avp parameter
343
+   Example 1.7. Set aor_avp parameter
364 344
 ...
365 345
 modparam("registrar", "aor_avp", "$avp(i:3223)")
366 346
 ...
367 347
 
368
-3.9. case_sensitive (integer)
348
+3.8. case_sensitive (integer)
369 349
 
370 350
    If set to 1 then AOR comparison will be case sensitive, if set to 0
371 351
    then AOR comparison will be case insensitive--This is recommended.
372 352
 
373 353
    Default value is 0.
374 354
 
375
-   Example 1.9. Set case_sensitive parameter
355
+   Example 1.8. Set case_sensitive parameter
376 356
 ...
377 357
 modparam("registrar", "case_sensitive", 1)
378 358
 ...
379 359
 
380
-3.10. received_avp (str)
360
+3.9. received_avp (str)
381 361
 
382 362
    Registrar will store the value of the AVP configured by this parameter
383 363
    in the received column in the user location database. It will leave the
... ...
@@ -392,24 +372,24 @@ Note
392 372
 
393 373
    Default value is "NULL" (disabled).
394 374
 
395
-   Example 1.10. Set received_avp parameter
375
+   Example 1.9. Set received_avp parameter
396 376
 ...
397 377
 modparam("registrar", "received_avp", "$avp(s:rcv)")
398 378
 ...
399 379
 
400
-3.11. received_param (string)
380
+3.10. received_param (string)
401 381
 
402 382
    The name of the parameter that will be appended to Contacts of 200 OK
403 383
    when the received URI was set by nathelper module.
404 384
 
405 385
    Default value is "received".
406 386
 
407
-   Example 1.11. Set received_param parameter
387
+   Example 1.10. Set received_param parameter
408 388
 ...
409 389
 modparam("registrar", "received_param", "rcv")
410 390
 ...
411 391
 
412
-3.12. max_contacts (integer)
392
+3.11. max_contacts (integer)
413 393
 
414 394
    The parameter can be used to limit the number of contacts per AOR
415 395
    (Address of Record) in the user location database. Value 0 disables the
... ...
@@ -417,13 +397,13 @@ modparam("registrar", "received_param", "rcv")
417 397
 
418 398
    Default value is 0.
419 399
 
420
-   Example 1.12. Set max_contacts parameter
400
+   Example 1.11. Set max_contacts parameter
421 401
 ...
422 402
 # Allow no more than 10 contacts per AOR
423 403
 modparam("registrar", "max_contacts", 10)
424 404
 ...
425 405
 
426
-3.13. retry_after (integer)
406
+3.12. retry_after (integer)
427 407
 
428 408
    The registrar can generate 5xx reply to REGISTER in various situations.
429 409
    It can, for example, happen when the max_contacts parameter is set and
... ...
@@ -436,12 +416,12 @@ modparam("registrar", "max_contacts", 10)
436 416
 
437 417
    Default value is 0 (disabled).
438 418
 
439
-   Example 1.13. Set retry_after parameter
419
+   Example 1.12. Set retry_after parameter
440 420
 ...
441 421
 modparam("registrar", "retry_after", 30)
442 422
 ...
443 423
 
444
-3.14. sock_flag (integer)
424
+3.13. sock_flag (integer)
445 425
 
446 426
    Message flag to signal to register module to look into REGISTER request
447 427
    for a header which contains a socket description (IP:port). This socket
... ...
@@ -451,12 +431,12 @@ modparam("registrar", "retry_after", 30)
451 431
 
452 432
    Default value is -1 (no flag).
453 433
 
454
-   Example 1.14. Set sock_flag parameter
434
+   Example 1.13. Set sock_flag parameter
455 435
 ...
456 436
 modparam("registrar", "sock_flag", 18)
457 437
 ...
458 438
 
459
-3.15. sock_hdr_name (string)
439
+3.14. sock_hdr_name (string)
460 440
 
461 441
    Header which contains a socket description (proto:IP:port) to override
462 442
    the received socket info. The header will be read only if the flag
... ...
@@ -466,36 +446,36 @@ modparam("registrar", "sock_flag", 18)
466 446
 
467 447
    Default value is NULL.
468 448
 
469
-   Example 1.15. Set sock_hdr_namer parameter
449
+   Example 1.14. Set sock_hdr_namer parameter
470 450
 ...
471 451
 modparam("registrar", "sock_hdr_name", "Sock-Info")
472 452
 ...
473 453
 
474
-3.16. method_filtering (integer)
454
+3.15. method_filtering (integer)
475 455
 
476 456
    Tells if the contact filtering based on supported methods should be
477 457
    performed during lookup. It's enabled only if it has a non zero value.
478 458
 
479 459
    Default value is 0 (disabled).
480 460
 
481
-   Example 1.16. Set method_filtering parameter
461
+   Example 1.15. Set method_filtering parameter
482 462
 ...
483 463
 modparam("registrar", "method_filtering", 1)
484 464
 ...
485 465
 
486
-3.17. use_path (integer)
466
+3.16. use_path (integer)
487 467
 
488 468
    If set to 1, the Path header is handled according to the parameter
489 469
    "path_mode".
490 470
 
491 471
    Default value is 0 (disabled).
492 472
 
493
-   Example 1.17. Set use_path parameter
473
+   Example 1.16. Set use_path parameter
494 474
 ...
495 475
 modparam("registrar", "use_path", 1)
496 476
 ...
497 477
 
498
-3.18. path_mode (integer)
478
+3.17. path_mode (integer)
499 479
 
500 480
    The registrar module implements three different modes regarding the
501 481
    response to a registration which includes one or more Path headers:
... ...
@@ -513,12 +493,12 @@ modparam("registrar", "use_path", 1)
513 493
 
514 494
    Default value is 2.
515 495
 
516
-   Example 1.18. Set path_mode parameter
496
+   Example 1.17. Set path_mode parameter
517 497
 ...
518 498
 modparam("registrar", "path_mode", 0)
519 499
 ...
520 500
 
521
-3.19. path_use_received (integer)
501
+3.18. path_use_received (integer)
522 502
 
523 503
    If set to 1, the "received" parameter of the first Path URI of a
524 504
    registration is set as received-uri and the NAT branch flag is set for
... ...
@@ -528,12 +508,12 @@ modparam("registrar", "path_mode", 0)
528 508
 
529 509
    Default value is 0 (disabled).
530 510
 
531
-   Example 1.19. Set path_use_received parameter
511
+   Example 1.18. Set path_use_received parameter
532 512
 ...
533 513
 modparam("registrar", "path_use_received", 1)
534 514
 ...
535 515
 
536
-3.20. reg_callid_avp (string)
516
+3.19. reg_callid_avp (string)
537 517
 
538 518
    If reg_callid_avp is defined and populated when registered() is
539 519
    invoked, the result is TRUE only if an active registration with the
... ...
@@ -541,7 +521,7 @@ modparam("registrar", "path_use_received", 1)
541 521
 
542 522
    Default value is NULL (disabled).
543 523
 
544
-   Example 1.20. Set reg_callid_avp parameter
524
+   Example 1.19. Set reg_callid_avp parameter
545 525
 ...
546 526
 modparam("registrar", "reg_callid_avp", "$avp(s:avp)")
547 527
 ...
... ...
@@ -579,7 +559,7 @@ modparam("registrar", "reg_callid_avp", "$avp(s:avp)")
579 559
 
580 560
    This function can be used from REQUEST_ROUTE and REPLY_ROUTE.
581 561
 
582
-   Example 1.21. save usage
562
+   Example 1.20. save usage
583 563
 ...
584 564
 save("location");
585 565
 ...
... ...
@@ -606,7 +586,7 @@ save("location");
606 586
 
607 587
    This function can be used from REQUEST_ROUTE and ONREPLY_ROUTE.
608 588
 
609
-   Example 1.22. save usage
589
+   Example 1.21. save usage
610 590
 ...
611 591
 save("location","0x01");
612 592
 ...
... ...
@@ -635,7 +615,7 @@ save("location","0x01");
635 615
 
636 616
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
637 617
 
638
-   Example 1.23. lookup usage
618
+   Example 1.22. lookup usage
639 619
 ...
640 620
 lookup("location");
641 621
 switch ($retcode) {
... ...
@@ -661,7 +641,7 @@ switch ($retcode) {
661 641
 
662 642
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
663 643
 
664
-   Example 1.24. registered usage
644
+   Example 1.23. registered usage
665 645
 ...
666 646
 if (registered("location")) {
667 647
         sl_send_reply("100", "Trying");
... ...
@@ -681,7 +661,7 @@ if (registered("location")) {
681 661
 
682 662
    This function can be used from REQUEST_ROUTE.
683 663
 
684
-   Example 1.25. add_sock_hdr usage
664
+   Example 1.24. add_sock_hdr usage
685 665
 ...
686 666
 add_sock_hdr("Sock-Info");
687 667
 ...
... ...
@@ -699,7 +679,7 @@ add_sock_hdr("Sock-Info");
699 679
 
700 680
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
701 681
 
702
-   Example 1.26. registered usage
682
+   Example 1.25. registered usage
703 683
 ...
704 684
 unregister("location", "$ru");
705 685
 unregister("location", "sip:user@kamailio.org");
... ...
@@ -721,7 +701,7 @@ unregister("location", "sip:user@kamailio.org");
721 701
 
722 702
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
723 703
 
724
-   Example 1.27. registered usage
704
+   Example 1.26. registered usage
725 705
 ...
726 706
 reg_fetch_contacts("location", "$ru", "callee");
727 707
 reg_fetch_contacts("location", "sip:user@kamailio.org", "caller");
... ...
@@ -740,7 +720,7 @@ reg_fetch_contacts("location", "sip:user@kamailio.org", "caller");
740 720
 
741 721
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
742 722
 
743
-   Example 1.28. registered usage
723
+   Example 1.27. registered usage
744 724
 ...
745 725
 reg_free_contacts("callee");
746 726
 ...
... ...
@@ -806,7 +786,7 @@ reg_free_contacts("callee");
806 786
    The pseudo-variable accepts positive index value to access a specific
807 787
    contact record.
808 788
 
809
-   Example 1.29. $sht(name) usage
789
+   Example 1.28. $sht(name) usage
810 790
 ...
811 791
 if(reg_fetch_contacts("location", "$fu", "caller"))
812 792
 {
... ...
@@ -197,31 +197,6 @@ modparam("registrar", "default_q", 1000)
197 197
 		</example>
198 198
 	</section>
199 199
 
200
-	<section>
201
-		<title><varname>tcp_persistent_flag</varname> (integer)</title>
202
-		<para>
203
-		The parameter specifies the message flag to be used to control the 
204
-		module behaviour regarding TCP connections. If the flag is set for a 
205
-		REGISTER via TCP containing a TCP contact, the module, via the 
206
-		<quote>save()</quote> functions will set the lifetime of the TCP
207
-		connection to the contact expire value. By doing this, the TCP 
208
-		connection will stay on as long as the contact is valid.
209
-		</para>
210
-		<para>
211
-		<emphasis>
212
-			Default value is -1 (disabled).
213
-		</emphasis>
214
-		</para>
215
-		<example>
216
-		<title>Set <varname>tcp_persistent_flag</varname> parameter</title>
217
-		<programlisting format="linespecific">
218
-...
219
-modparam("registrar", "tcp_persistent_flag", 7)
220
-...
221
-</programlisting>
222
-		</example>
223
-	</section>
224
-
225 200
 	<section>
226 201
 		<title><varname>realm_prefix</varname> (string)</title>
227 202
 		<para>
... ...
@@ -41,6 +41,8 @@
41 41
  *              contacts and default expiry time(Jeffrey Magder-SOMA Networks)
42 42
  *  2007-02-24  sip_natping_flag moved into branch flags, so migrated to 
43 43
  *              nathelper module (bogdan)
44
+ *  2009-12-09  Commented out tcp_persistent_flag param, because sr_3.0 tm
45
+ *              does not support it (Juha)
44 46
  *
45 47
  */
46 48
 
... ...
@@ -191,7 +193,7 @@ static param_export_t params[] = {
191 193
 	{"default_q",          INT_PARAM, &default_q           },
192 194
 	{"append_branches",    INT_PARAM, &append_branches     },
193 195
 	{"case_sensitive",     INT_PARAM, &case_sensitive      },
194
-	{"tcp_persistent_flag",INT_PARAM, &tcp_persistent_flag },
196
+	/*	{"tcp_persistent_flag",INT_PARAM, &tcp_persistent_flag }, */
195 197
 	{"realm_prefix",       STR_PARAM, &realm_pref          },
196 198
 	{"min_expires",        INT_PARAM, &min_expires         },
197 199
 	{"max_expires",        INT_PARAM, &max_expires         },