Browse code

- for each function are listed the route types where can be used

git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@294 689a6050-402a-0410-94f2-e92a70836424

Elena-Ramona Modroiu authored on 07/10/2005 11:43:53
Showing 32 changed files
... ...
@@ -663,6 +663,8 @@ modparam("acc", "dst_leg_avp_id", 110)
663 663
 
664 664
      * comment - Comment to be appended.
665 665
 
666
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
667
+
666 668
    Example 1-27. acc_log_request usage
667 669
 ...
668 670
 acc_log_request("Some comment");
... ...
@@ -680,6 +682,8 @@ acc_log_request("Some comment");
680 682
      * comment - Comment to be appended.
681 683
      * table - Database table to be used.
682 684
 
685
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
686
+
683 687
    Example 1-28. acc_db_request usage
684 688
 ...
685 689
 acc_log_request("Some comment", "Some table");
... ...
@@ -695,6 +699,8 @@ acc_log_request("Some comment", "Some table");
695 699
 
696 700
      * comment - Comment to be appended.
697 701
 
702
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
703
+
698 704
    Example 1-29. acc_rad_request usage
699 705
 ...
700 706
 acc_rad_request("Some comment");
... ...
@@ -710,6 +716,8 @@ acc_rad_request("Some comment");
710 716
 
711 717
      * comment - Comment to be appended.
712 718
 
719
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
720
+
713 721
    Example 1-30. acc_diam_request usage
714 722
 ...
715 723
 acc_diam_request("Some comment");
... ...
@@ -738,9 +746,9 @@ Chapter 3. Frequently Asked Questions
738 746
    one of our mailing lists:
739 747
 
740 748
      * User Mailing List -
741
-       http://openser.org/mailman/listinfo/users
749
+       http://openser.org/cgi-bin/mailman/listinfo/users
742 750
      * Developer Mailing List -
743
-       http://openser.org/mailman/listinfo/devel
751
+       http://openser.org/cgi-bin/mailman/listinfo/devel
744 752
 
745 753
    E-mails regarding any stable OpenSER release should be sent to
746 754
    <users@openser.org> and e-mails regarding development versions
... ...
@@ -786,6 +786,9 @@ modparam("acc", "dst_leg_avp_id", 110)
786 786
 			</para>
787 787
 		</listitem>
788 788
 		</itemizedlist>
789
+		<para>
790
+		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
791
+		</para>
789 792
 		<example>
790 793
 		<title>acc_log_request usage</title>
791 794
 		<programlisting format="linespecific">
... ...
@@ -814,6 +817,9 @@ acc_log_request("Some comment");
814 817
 			<para><emphasis>table</emphasis> - Database table to be used.</para>
815 818
 		</listitem>
816 819
 		</itemizedlist>
820
+		<para>
821
+		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
822
+		</para>
817 823
 		<example>
818 824
 		<title>acc_db_request usage</title>
819 825
 		<programlisting format="linespecific">
... ...
@@ -838,6 +844,9 @@ acc_log_request("Some comment", "Some table");
838 844
 			</para>
839 845
 		</listitem>
840 846
 		</itemizedlist>
847
+		<para>
848
+		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
849
+		</para>
841 850
 		<example>
842 851
 		<title>acc_rad_request usage</title>
843 852
 		<programlisting format="linespecific">
... ...
@@ -862,6 +871,9 @@ acc_rad_request("Some comment");
862 871
 			</para>
863 872
 		</listitem>
864 873
 		</itemizedlist>
874
+		<para>
875
+		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
876
+		</para>
865 877
 		<example>
866 878
 		<title>acc_diam_request usage</title>
867 879
 		<programlisting format="linespecific">
... ...
@@ -191,6 +191,8 @@ modparam("alias_db", "domain_prefix", "sip.")
191 191
      * table_name - the name of the table where to search for
192 192
        alias.
193 193
 
194
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
195
+
194 196
    Example 1-8. alias_db_lookup() usage
195 197
 ...
196 198
 alias_db_lookup("dbaliases");
... ...
@@ -239,9 +241,9 @@ Chapter 3. Frequently Asked Questions
239 241
    one of our mailing lists:
240 242
 
241 243
      * User Mailing List -
242
-       http://openser.org/mailman/listinfo/users
244
+       http://openser.org/cgi-bin/mailman/listinfo/users
243 245
      * Developer Mailing List -
244
-       http://openser.org/mailman/listinfo/devel
246
+       http://openser.org/cgi-bin/mailman/listinfo/devel
245 247
 
246 248
    E-mails regarding any stable OpenSER release should be sent to
247 249
    <users@openser.org> and e-mails regarding development versions
... ...
@@ -225,6 +225,9 @@ modparam("alias_db", "domain_prefix", "sip.")
225 225
 		    </para>
226 226
 		</listitem>
227 227
 	    </itemizedlist>
228
+		<para>
229
+		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
230
+		</para>
228 231
 	    <example>
229 232
 		<title><function>alias_db_lookup()</function> usage</title>
230 233
 		<programlisting format="linespecific">
... ...
@@ -159,6 +159,8 @@ modparam("auth_diameter", "use_domain", 1)
159 159
      * realm - the realm to be use for authentication and
160 160
        authorization.
161 161
 
162
+   This function can be used from REQUEST_ROUTE.
163
+
162 164
    Example 1-5. diameter_www_authorize usage
163 165
 ...
164 166
 if(!diameter_www_authorize("siphub.net"))
... ...
@@ -181,6 +183,8 @@ if(!diameter_www_authorize("siphub.net"))
181 183
      * realm - the realm to be use for authentication and
182 184
        authorization.
183 185
 
186
+   This function can be used from REQUEST_ROUTE.
187
+
184 188
    Example 1-6. diameter_proxy_authorize usage
185 189
 ...
186 190
 if(!diameter_proxy_authorize("siphub.net"))
... ...
@@ -202,6 +206,8 @@ if(!diameter_proxy_authorize("siphub.net"))
202 206
      * group - the group name where to check if the user is part
203 207
        of.
204 208
 
209
+   This function can be used from REQUEST_ROUTE.
210
+
205 211
    Example 1-7. diameter_is_user_in usage
206 212
 ...
207 213
 if(!diameter_is_user_in("From", "voicemail"))
... ...
@@ -238,9 +244,9 @@ Chapter 3. Frequently Asked Questions
238 244
    one of our mailing lists:
239 245
 
240 246
      * User Mailing List -
241
-       http://openser.org/mailman/listinfo/users
247
+       http://openser.org/cgi-bin/mailman/listinfo/users
242 248
      * Developer Mailing List -
243
-       http://openser.org/mailman/listinfo/devel
249
+       http://openser.org/cgi-bin/mailman/listinfo/devel
244 250
 
245 251
    E-mails regarding any stable OpenSER release should be sent to
246 252
    <users@openser.org> and e-mails regarding development versions
... ...
@@ -164,6 +164,9 @@ modparam("auth_diameter", "use_domain", 1)
164 164
 		    </para>
165 165
 		</listitem>
166 166
 	    </itemizedlist>
167
+		<para>
168
+		This function can be used from REQUEST_ROUTE.
169
+		</para>
167 170
 	    <example>
168 171
 		<title><function>diameter_www_authorize</function> usage</title>
169 172
 		<programlisting format="linespecific">
... ...
@@ -194,6 +197,9 @@ if(!diameter_www_authorize("siphub.net"))
194 197
 		    </para>
195 198
 		</listitem>
196 199
 	    </itemizedlist>
200
+		<para>
201
+		This function can be used from REQUEST_ROUTE.
202
+		</para>
197 203
 	    <example>
198 204
 		<title><function>diameter_proxy_authorize</function> usage</title>
199 205
 		<programlisting format="linespecific">
... ...
@@ -228,6 +234,9 @@ if(!diameter_proxy_authorize("siphub.net"))
228 234
 		    </para>
229 235
 		</listitem>
230 236
 	    </itemizedlist>
237
+		<para>
238
+		This function can be used from REQUEST_ROUTE.
239
+		</para>
231 240
 	    <example>
232 241
 		<title><function>diameter_is_user_in</function> usage</title>
233 242
 		<programlisting format="linespecific">
... ...
@@ -274,6 +274,9 @@ modparam("avpops","db_scheme",
274 274
           + name = avp_spec['/'(table_name|'$'db_scheme)] 
275 275
           + avp_spec = ''|'s:'|'i:'|avp_name|avp_alias 
276 276
 
277
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
278
+   BRANCH_ROUTE.
279
+
277 280
    Example 1-12. avp_db_load usage
278 281
 ...
279 282
 avp_db_load("$from","i:678");
... ...
@@ -291,6 +294,9 @@ avp_db_load("$ruri","i:123/$some_scheme");
291 294
    avp_db_load(source,name) function. Please refer to its
292 295
    description.
293 296
 
297
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
298
+   BRANCH_ROUTE.
299
+
294 300
    Example 1-13. avp_db_store usage
295 301
 ...
296 302
 avp_db_store("$to","i:678");
... ...
@@ -306,6 +312,9 @@ avp_db_store("$ruri/username","$email");
306 312
    avp_db_load(source,name) function. Please refer to its
307 313
    description.
308 314
 
315
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
316
+   BRANCH_ROUTE.
317
+
309 318
    Example 1-14. avp_db_delete usage
310 319
 ...
311 320
 avp_db_delete("$to","i:678");
... ...
@@ -334,6 +343,9 @@ avp_db_delete("$uuid","s:404fwd/fwd_table");
334 343
        is:
335 344
           + name = avp_name | avp_alias 
336 345
 
346
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
347
+   BRANCH_ROUTE.
348
+
337 349
    Example 1-15. avp_write usage
338 350
 ...
339 351
 avp_write("$to","i:678");
... ...
@@ -356,6 +368,9 @@ avp_write("i:333","i:6");
356 368
           + name = (''|'s:'|'i:'|avp_name|avp_alias)['/'flag] 
357 369
           + flag = 'g'|'G' 
358 370
 
371
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
372
+   BRANCH_ROUTE.
373
+
359 374
    Example 1-16. avp_delete usage
360 375
 ...
361 376
 avp_delete("i:678/g");
... ...
@@ -381,6 +396,9 @@ avp_delete("");
381 396
           + name = ( avp_name | avp_alias )['/'flags] 
382 397
           + flags = 'g' 
383 398
 
399
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
400
+   BRANCH_ROUTE.
401
+
384 402
    Example 1-17. avp_pushto usage
385 403
 ...
386 404
 avp_pushto("$ruri","i:678");
... ...
@@ -413,6 +431,9 @@ avp_pushto("$Foo","$bar/g");
413 431
        Integer values can be given in hexadecimal using notation:
414 432
        'i:0xhex_number' (e.g.,: 'i:0xabcd');
415 433
 
434
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
435
+   BRANCH_ROUTE.
436
+
416 437
    Example 1-18. avp_check usage
417 438
 ...
418 439
 avp_check("i:678", "lt/i:345/g");
... ...
@@ -437,6 +458,9 @@ avp_check("s:foo","fm/$fm_avp/g");
437 458
           + name = ( avp_name | avp_alias ) ['/'flags] 
438 459
           + flags = 'g' | 'G' | 'd' | 'D' | 'n' | 'N' | 's' | 'S'
439 460
        
461
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
462
+   BRANCH_ROUTE.
463
+
440 464
    Example 1-19. avp_copy usage
441 465
 ...
442 466
 avp_copy("i:678", "s:345/g");
... ...
@@ -458,6 +482,9 @@ avp_copy("$old","$new/gd");
458 482
           + name = ( avp_name | avp_alias ) 
459 483
      * format - the formatted string to be printed in 'dest' AVP.
460 484
 
485
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
486
+   BRANCH_ROUTE.
487
+
461 488
    Example 1-20. avp_printf usage
462 489
 ...
463 490
 avp_printf("i:20", "This is a $rm request with the call-id $hdr(call-id
... ...
@@ -489,6 +516,9 @@ avp_printf("i:20", "This is a $rm request with the call-id $hdr(call-id
489 516
           + flags = 'g' | 'G' | 'i' | 'i' (g, G - replace all
490 517
             matching tokens; i, I - match ignore case) 
491 518
 
519
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
520
+   BRANCH_ROUTE.
521
+
492 522
    Example 1-21. avp_subst usage
493 523
 ...
494 524
 # if avp i:678 has a string value in e-mail format, replace the
... ...
@@ -534,6 +564,9 @@ avp_subst("i:678/i:679/g", "/(.*)@(.*)/\1@$rd/");
534 564
        Integer values can be given in hexadecimal using notation
535 565
        'i:0xhex_number' (e.g.,: 'i:0xabcd');
536 566
 
567
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
568
+   BRANCH_ROUTE.
569
+
537 570
    Example 1-22. avp_op usage
538 571
 ...
539 572
 avp_op("i:678", "add/i:345/g");
... ...
@@ -552,6 +585,9 @@ avp_op("$number","sub/$number2/d");
552 585
             flags = ('s'|'n') - s = value string; n = value
553 586
             number (int) 
554 587
 
588
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
589
+   BRANCH_ROUTE.
590
+
555 591
    Example 1-23. is_avp_set usage
556 592
 ...
557 593
 if(is_avp_set("i:678"))
... ...
@@ -564,6 +600,9 @@ if(is_avp_set("i:678"))
564 600
    Prints the list with all the AVPs from memory. This is only a
565 601
    helper/debug function.
566 602
 
603
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
604
+   BRANCH_ROUTE.
605
+
567 606
    Example 1-24. avp_print usage
568 607
 ...
569 608
 avp_print();
... ...
@@ -315,6 +315,10 @@ modparam("avpops","db_scheme",
315 315
 				</para>
316 316
 			</listitem>
317 317
 			</itemizedlist>
318
+			<para>
319
+			This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.
320
+			</para>
321
+			
318 322
 			<example>
319 323
 				<title><function>avp_db_load</function> usage</title>
320 324
 				<programlisting format="linespecific">
... ...
@@ -339,6 +343,10 @@ avp_db_load("$ruri","i:123/$some_scheme");
339 343
 			<emphasis>avp_db_load(source,name)</emphasis>
340 344
 			function. Please refer to its description.
341 345
 			</para>
346
+			<para>
347
+			This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.
348
+			</para>
349
+			
342 350
 			<example>
343 351
 				<title><function>avp_db_store</function> usage</title>
344 352
 				<programlisting format="linespecific">
... ...
@@ -360,6 +368,9 @@ avp_db_store("$ruri/username","$email");
360 368
 			<emphasis>avp_db_load(source,name)</emphasis>
361 369
 			function. Please refer to its description.
362 370
 			</para>
371
+			<para>
372
+			This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.
373
+			</para>
363 374
 			<example>
364 375
 				<title><function>avp_db_delete</function> usage</title>
365 376
 				<programlisting format="linespecific">
... ...
@@ -416,6 +427,9 @@ avp_db_delete("$uuid","s:404fwd/fwd_table");
416 427
 				</para>
417 428
 			</listitem>
418 429
 			</itemizedlist>
430
+			<para>
431
+			This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.
432
+			</para>
419 433
 			<example>
420 434
 				<title><function>avp_write</function> usage</title>
421 435
 				<programlisting format="linespecific">
... ...
@@ -456,6 +470,9 @@ avp_write("i:333","i:6");
456 470
 				</para>
457 471
 			</listitem>
458 472
 			</itemizedlist>
473
+			<para>
474
+			This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.
475
+			</para>
459 476
 			<example>
460 477
 				<title><function>avp_delete</function> usage</title>
461 478
 				<programlisting format="linespecific">
... ...
@@ -510,6 +527,9 @@ avp_delete("");
510 527
 				</para>
511 528
 			</listitem>
512 529
 			</itemizedlist>
530
+			<para>
531
+			This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.
532
+			</para>
513 533
 			<example>
514 534
 				<title><function>avp_pushto</function> usage</title>
515 535
 				<programlisting format="linespecific">
... ...
@@ -575,6 +595,9 @@ avp_pushto("$Foo","$bar/g");
575 595
 				</para>
576 596
 			</listitem>
577 597
 			</itemizedlist>
598
+			<para>
599
+			This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.
600
+			</para>
578 601
 			<example>
579 602
 				<title><function>avp_check</function> usage</title>
580 603
 				<programlisting format="linespecific">
... ...
@@ -624,6 +647,9 @@ avp_check("s:foo","fm/$fm_avp/g");
624 647
 				</para>
625 648
 			</listitem>
626 649
 			</itemizedlist>
650
+			<para>
651
+			This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.
652
+			</para>
627 653
 			<example>
628 654
 				<title><function>avp_copy</function> usage</title>
629 655
 				<programlisting format="linespecific">
... ...
@@ -664,6 +690,9 @@ avp_copy("$old","$new/gd");
664 690
 				</para>
665 691
 			</listitem>
666 692
 			</itemizedlist>
693
+			<para>
694
+			This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.
695
+			</para>
667 696
 			<example>
668 697
 				<title><function>avp_printf</function> usage</title>
669 698
 				<programlisting format="linespecific">
... ...
@@ -725,6 +754,9 @@ avp_printf("i:20", "This is a $rm request with the call-id $hdr(call-id)");
725 754
 				</para>
726 755
 			</listitem>
727 756
 			</itemizedlist>
757
+			<para>
758
+			This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.
759
+			</para>
728 760
 			<example>
729 761
 				<title><function>avp_subst</function> usage</title>
730 762
 				<programlisting format="linespecific">
... ...
@@ -814,6 +846,9 @@ avp_subst("i:678/i:679/g", "/(.*)@(.*)/\1@$rd/");
814 846
 				</para>
815 847
 			</listitem>
816 848
 			</itemizedlist>
849
+			<para>
850
+			This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.
851
+			</para>
817 852
 			<example>
818 853
 				<title><function>avp_op</function> usage</title>
819 854
 				<programlisting format="linespecific">
... ...
@@ -848,6 +883,9 @@ avp_op("$number","sub/$number2/d");
848 883
 				</para>
849 884
 			</listitem>
850 885
 			</itemizedlist>
886
+			<para>
887
+			This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.
888
+			</para>
851 889
 			<example>
852 890
 				<title><function>is_avp_set</function> usage</title>
853 891
 				<programlisting format="linespecific">
... ...
@@ -867,6 +905,9 @@ if(is_avp_set("i:678"))
867 905
 			Prints the list with all the AVPs from memory. This is only a
868 906
 			helper/debug function.
869 907
 			</para>
908
+			<para>
909
+			This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.
910
+			</para>
870 911
 			<example>
871 912
 				<title><function>avp_print</function> usage</title>
872 913
 				<programlisting format="linespecific">
... ...
@@ -336,6 +336,8 @@ modparam("cpl_c","lookup_append_branches",1)
336 336
        time, if returning to script, it will be in stateless mode
337 337
        (easy to continue the routing script execution)
338 338
 
339
+   This function can be used from REQUEST_ROUTE.
340
+
339 341
    Example 1-13. cpl_run_script usage
340 342
 ...
341 343
 cpl_run_script("incoming","force_stateful");
... ...
@@ -364,6 +366,8 @@ cpl_run_script("incoming","force_stateful");
364 366
    itself the necessary replies (stateless - using sl), including
365 367
    for errors.
366 368
 
369
+   This function can be used from REQUEST_ROUTE.
370
+
367 371
    Example 1-14. cpl_process_register usage
368 372
 ...
369 373
 if (method=="REGISTER") {
... ...
@@ -381,6 +385,8 @@ if (method=="REGISTER") {
381 385
    Main purpose of this function is to allow integration between
382 386
    CPL and UserLocation services via same REGISTER messages.
383 387
 
388
+   This function can be used from REQUEST_ROUTE.
389
+
384 390
    Example 1-15. cpl_process_register_norpl usage 
385 391
 ...
386 392
 if (method=="REGISTER") {
... ...
@@ -418,9 +424,9 @@ Chapter 3. Frequently Asked Questions
418 424
    one of our mailing lists:
419 425
 
420 426
      * User Mailing List -
421
-       http://openser.org/mailman/listinfo/users
427
+       http://openser.org/cgi-bin/mailman/listinfo/users
422 428
      * Developer Mailing List -
423
-       http://openser.org/mailman/listinfo/devel
429
+       http://openser.org/cgi-bin/mailman/listinfo/devel
424 430
 
425 431
    E-mails regarding any stable OpenSER release should be sent to
426 432
    <users@openser.org> and e-mails regarding development versions
... ...
@@ -423,6 +423,9 @@ modparam("cpl_c","lookup_append_branches",1)
423 423
 				</para>
424 424
 			</listitem>
425 425
 			</itemizedlist>
426
+			<para>
427
+			This function can be used from REQUEST_ROUTE.
428
+			</para>
426 429
 			<example>
427 430
 				<title><function>cpl_run_script</function> usage</title>
428 431
 				<programlisting format="linespecific">
... ...
@@ -457,6 +460,9 @@ cpl_run_script("incoming","force_stateful");
457 460
 				itself the necessary replies (stateless - using sl), including 
458 461
 				for errors.
459 462
 			</para>
463
+			<para>
464
+			This function can be used from REQUEST_ROUTE.
465
+			</para>
460 466
 			<example>
461 467
 				<title><function>cpl_process_register</function> usage</title>
462 468
 				<programlisting format="linespecific">
... ...
@@ -483,6 +489,9 @@ if (method=="REGISTER") {
483 489
 				between CPL and UserLocation services via same REGISTER
484 490
 				messages.
485 491
 			</para>
492
+			<para>
493
+			This function can be used from REQUEST_ROUTE.
494
+			</para>
486 495
 			<example>
487 496
 				<title><function>cpl_process_register_norpl</function> usage
488 497
 					</title>
... ...
@@ -145,6 +145,8 @@ modparam("dispatcher", "force_dst", 1)
145 145
           + "X" - if the algorithm is not implemented, the first
146 146
             entry in set is chosen.
147 147
 
148
+   This function can be used from REQUEST_ROUTE.
149
+
148 150
    Example 1-4. ds_select_dst usage
149 151
 ...
150 152
 ds_select_dst("1", "0");
... ...
@@ -156,6 +158,8 @@ ds_select_dst("1", "0");
156 158
    The method selects a destination from addresses set and
157 159
    rewrites the host and port from R-URI. The parameters have
158 160
    same meaning as for ds_select_dst().
161
+
162
+   This function can be used from REQUEST_ROUTE.
159 163
      _________________________________________________________
160 164
 
161 165
 1.5. Installation & Running
... ...
@@ -178,6 +178,9 @@ modparam("dispatcher", "force_dst", 1)
178 178
 			</itemizedlist>
179 179
 		</listitem>
180 180
 		</itemizedlist>
181
+		<para>
182
+		This function can be used from REQUEST_ROUTE.
183
+		</para>
181 184
 		<example>
182 185
 		<title><function>ds_select_dst</function> usage</title>
183 186
 		<programlisting format="linespecific">
... ...
@@ -196,6 +199,9 @@ ds_select_dst("1", "0");
196 199
  		host and port from R-URI. The parameters have same meaning as for
197 200
  		ds_select_dst().
198 201
  	    <para>
202
+		<para>
203
+		This function can be used from REQUEST_ROUTE.
204
+		</para>
199 205
  	</section>
200 206
 	</section>
201 207
 	<section>
... ...
@@ -45,11 +45,10 @@ Daniel-Constantin Mierla
45 45
         1.6. Exported Functions
46 46
 
47 47
               1.6.1. jab_send_message()
48
-              1.6.2. jab_send_message()
49
-              1.6.3. jab_join_jconf()
50
-              1.6.4. jab_exit_jconf()
51
-              1.6.5. jab_go_online()
52
-              1.6.6. jab_go_offline()
48
+              1.6.2. jab_join_jconf()
49
+              1.6.3. jab_exit_jconf()
50
+              1.6.4. jab_go_online()
51
+              1.6.5. jab_go_offline()
53 52
 
54 53
    2. Developer's Guide
55 54
    3. Frequently Asked Questions
... ...
@@ -69,11 +68,10 @@ Daniel-Constantin Mierla
69 68
    1-12. Set sleep_time parameter
70 69
    1-13. Set check_time parameter
71 70
    1-14. jab_send_message() usage
72
-   1-15. jab_send_message() usage
73
-   1-16. jab_join_jconf() usage
74
-   1-17. jab_exit_jconf() usage
75
-   1-18. jab_go_online() usage
76
-   1-19. jab_go_offline() usage
71
+   1-15. jab_join_jconf() usage
72
+   1-16. jab_exit_jconf() usage
73
+   1-17. jab_go_online() usage
74
+   1-18. jab_go_offline() usage
77 75
      _________________________________________________________
78 76
 
79 77
 Chapter 1. User's Guide
... ...
@@ -450,65 +448,64 @@ modparam("jabber", "check_time", 20)
450 448
    Converts SIP MESSAGE message to a Jabber message and sends it
451 449
    to Jabber server.
452 450
 
453
-   Example 1-14. jab_send_message() usage
454
-...
455
-jab_send_message();
456
-...
457
-     _________________________________________________________
458
-
459
-1.6.2. jab_send_message()
460
-
461
-   Converts SIP MESSAGE message to a Jabber message and sends it
462
-   to Jabber server.
451
+   This function can be used from REQUEST_ROUTE.
463 452
 
464
-   Example 1-15. jab_send_message() usage
453
+   Example 1-14. jab_send_message() usage
465 454
 ...
466 455
 jab_send_message();
467 456
 ...
468 457
      _________________________________________________________
469 458
 
470
-1.6.3. jab_join_jconf()
459
+1.6.2. jab_join_jconf()
471 460
 
472 461
    Join a Jabber conference--the nickname, room name and
473 462
    conference server address should be included in To header as:
474 463
    nickname%roomname%conference_server@jdomain . If the nickname
475 464
    is missing, then the SIP username is used.
476 465
 
477
-   Example 1-16. jab_join_jconf() usage
466
+   This function can be used from REQUEST_ROUTE.
467
+
468
+   Example 1-15. jab_join_jconf() usage
478 469
 ...
479 470
 jab_join_jconf();
480 471
 ...
481 472
      _________________________________________________________
482 473
 
483
-1.6.4. jab_exit_jconf()
474
+1.6.3. jab_exit_jconf()
484 475
 
485 476
    Leave a Jabber conference--the nickname, room name and
486 477
    conference server address should be included in To header as:
487 478
    nickname%roomname%conference_server@jdomain .
488 479
 
489
-   Example 1-17. jab_exit_jconf() usage
480
+   This function can be used from REQUEST_ROUTE.
481
+
482
+   Example 1-16. jab_exit_jconf() usage
490 483
 ...
491 484
 jab_exit_jconf();
492 485
 ...
493 486
      _________________________________________________________
494 487
 
495
-1.6.5. jab_go_online()
488
+1.6.4. jab_go_online()
496 489
 
497 490
    Register to the Jabber server with associated Jabber ID of the
498 491
    SIP user.
499 492
 
500
-   Example 1-18. jab_go_online() usage
493
+   This function can be used from REQUEST_ROUTE.
494
+
495
+   Example 1-17. jab_go_online() usage
501 496
 ...
502 497
 jab_go_online();
503 498
 ...
504 499
      _________________________________________________________
505 500
 
506
-1.6.6. jab_go_offline()
501
+1.6.5. jab_go_offline()
507 502
 
508 503
    Log off from Jabber server the associated Jabber ID of the SIP
509 504
    user.
510 505
 
511
-   Example 1-19. jab_go_offline() usage
506
+   This function can be used from REQUEST_ROUTE.
507
+
508
+   Example 1-18. jab_go_offline() usage
512 509
 ...
513 510
 jab_go_offline();
514 511
 ...
... ...
@@ -536,9 +533,9 @@ Chapter 3. Frequently Asked Questions
536 533
    one of our mailing lists:
537 534
 
538 535
      * User Mailing List -
539
-       http://openser.org/mailman/listinfo/users
536
+       http://openser.org/cgi-bin/mailman/listinfo/users
540 537
      * Developer Mailing List -
541
-       http://openser.org/mailman/listinfo/devel
538
+       http://openser.org/cgi-bin/mailman/listinfo/devel
542 539
 
543 540
    E-mails regarding any stable OpenSER release should be sent to
544 541
    <users@openser.org> and e-mails regarding development versions
... ...
@@ -613,22 +613,9 @@ modparam("jabber", "check_time", 20)
613 613
 	    <para>
614 614
 		Converts &sip; MESSAGE message to a Jabber message and sends it to Jabber server.
615 615
 	    </para>
616
-	    <example>
617
-		<title><function>jab_send_message()</function> usage</title>
618
-		<programlisting format="linespecific">
619
-...
620
-jab_send_message();
621
-...
622
-</programlisting>
623
-	    </example>
624
-	</section>
625
-	<section>
626
-	    <title>
627
-		<function moreinfo="none">jab_send_message()</function>
628
-	    </title>
629
-	    <para>
630
-		Converts &sip; MESSAGE message to a Jabber message and sends it to Jabber server.
631
-	    </para>
616
+		<para>
617
+		This function can be used from REQUEST_ROUTE.
618
+		</para>
632 619
 	    <example>
633 620
 		<title><function>jab_send_message()</function> usage</title>
634 621
 		<programlisting format="linespecific">
... ...
@@ -647,6 +634,9 @@ jab_send_message();
647 634
 		should be included in To header as: nickname%roomname%conference_server@jdomain . If
648 635
 		the nickname is missing, then the &sip; username is used.
649 636
 	    </para>
637
+		<para>
638
+		This function can be used from REQUEST_ROUTE.
639
+		</para>
650 640
 	    <example>
651 641
 		<title><function>jab_join_jconf()</function> usage</title>
652 642
 		<programlisting format="linespecific">
... ...
@@ -664,6 +654,9 @@ jab_join_jconf();
664 654
 		Leave a Jabber conference--the nickname, room name and conference server address
665 655
 		should be included in To header as: nickname%roomname%conference_server@jdomain .
666 656
 	    </para>
657
+		<para>
658
+		This function can be used from REQUEST_ROUTE.
659
+		</para>
667 660
 	    <example>
668 661
 		<title><function>jab_exit_jconf()</function> usage</title>
669 662
 		<programlisting format="linespecific">
... ...
@@ -681,6 +674,9 @@ jab_exit_jconf();
681 674
 	    <para>
682 675
 		Register to the Jabber server with associated Jabber <abbrev>ID</abbrev> of the &sip; user.
683 676
 	    </para>
677
+		<para>
678
+		This function can be used from REQUEST_ROUTE.
679
+		</para>
684 680
 	    <example>
685 681
 		<title><function>jab_go_online()</function> usage</title>
686 682
 		<programlisting format="linespecific">
... ...
@@ -698,6 +694,9 @@ jab_go_online();
698 694
 	    <para>
699 695
 		Log off from Jabber server the associated Jabber <abbrev>ID</abbrev> of the &sip; user.
700 696
 	    </para>
697
+		<para>
698
+		This function can be used from REQUEST_ROUTE.
699
+		</para>
701 700
 	    <example>
702 701
 		<title><function>jab_go_offline()</function> usage</title>
703 702
 		<programlisting format="linespecific">
... ...
@@ -226,6 +226,8 @@ modparam("msilo", "use_contact", 0)
226 226
           + "1" - look first at R-URI and then at URI from "To"
227 227
             header.
228 228
           + "2" - look only at URI form "To" header.
229
+
230
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
229 231
      _________________________________________________________
230 232
 
231 233
 1.4.2. m_dump()
... ...
@@ -234,6 +236,8 @@ modparam("msilo", "use_contact", 0)
234 236
    going to register to his actual contact address. The method
235 237
    should be called when a REGISTER request is received and the
236 238
    "Expire" header has a value greater than zero.
239
+
240
+   This function can be used from REQUEST_ROUTE.
237 241
      _________________________________________________________
238 242
 
239 243
 1.5. Installation & Running
... ...
@@ -469,9 +473,9 @@ Chapter 3. Frequently Asked Questions
469 473
    one of our mailing lists:
470 474
 
471 475
      * User Mailing List -
472
-       http://openser.org/mailman/listinfo/users
476
+       http://openser.org/cgi-bin/mailman/listinfo/users
473 477
      * Developer Mailing List -
474
-       http://openser.org/mailman/listinfo/devel
478
+       http://openser.org/cgi-bin/mailman/listinfo/devel
475 479
 
476 480
    E-mails regarding any stable OpenSER release should be sent to
477 481
    <users@openser.org> and e-mails regarding development versions
... ...
@@ -261,6 +261,9 @@ modparam("msilo", "use_contact", 0)
261 261
 		    </itemizedlist>
262 262
 		</listitem>
263 263
 	    </itemizedlist>
264
+		<para>
265
+		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
266
+		</para>
264 267
 	</section>
265 268
 	<section>
266 269
 	    <title><function moreinfo="none">m_dump()</function></title>
... ...
@@ -269,6 +272,9 @@ modparam("msilo", "use_contact", 0)
269 272
 		actual contact address. The method should be called when a REGISTER request is
270 273
 		received and the <quote>Expire</quote> header has a value greater than zero.
271 274
 	    </para>
275
+		<para>
276
+		This function can be used from REQUEST_ROUTE.
277
+		</para>
272 278
 	</section>
273 279
     </section>
274 280
     <section>
... ...
@@ -238,6 +238,8 @@ modparam("pdt", "clean_time", 600)
238 238
    is removed. If the values is "2" the user part of the URI is
239 239
    not changed.
240 240
 
241
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
242
+
241 243
    Example 1-10. prefix2domain usage
242 244
 ...
243 245
 prefix2domain();
... ...
@@ -293,9 +295,9 @@ Chapter 3. Frequently Asked Questions
293 295
    one of our mailing lists:
294 296
 
295 297
      * User Mailing List -
296
-       http://openser.org/mailman/listinfo/users
298
+       http://openser.org/cgi-bin/mailman/listinfo/users
297 299
      * Developer Mailing List -
298
-       http://openser.org/mailman/listinfo/devel
300
+       http://openser.org/cgi-bin/mailman/listinfo/devel
299 301
 
300 302
    E-mails regarding any stable OpenSER release should be sent to
301 303
    <users@openser.org> and e-mails regarding development versions
... ...
@@ -287,7 +287,10 @@ modparam("pdt", "clean_time", 600)
287 287
 		prefix is removed. If the values is <quote>2</quote> the user part
288 288
 		of the URI is not changed.
289 289
 		</para>
290
-	    <example>
290
+	    <para>
291
+		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
292
+		</para>
293
+		<example>
291 294
 		<title><function>prefix2domain</function> usage</title>
292 295
 		<programlisting format="linespecific">
293 296
 ...
... ...
@@ -221,6 +221,8 @@ modparam("rr", "add_username", 1)
221 221
    The function performs loose routing as defined in RFC3261. See
222 222
    the RFC3261 for more details.
223 223
 
224
+   This function can be used from REQUEST_ROUTE.
225
+
224 226
    Example 1-6. loose_route usage
225 227
 ...
226 228
 loose_route();
... ...
@@ -245,6 +247,8 @@ strict_route();
245 247
    field will be inserted in the message before any other
246 248
    Record-Route header fields.
247 249
 
250
+   This function can be used from REQUEST_ROUTE.
251
+
248 252
    Example 1-8. record_route usage
249 253
 ...
250 254
 record_route();
... ...
@@ -260,6 +264,8 @@ record_route();
260 264
 
261 265
      * string - String to be inserted into the header field.
262 266
 
267
+   This function can be used from REQUEST_ROUTE.
268
+
263 269
    Example 1-9. record_route_preset usage
264 270
 ...
265 271
 record_route_preset("1.2.3.4:5090");
... ...
@@ -277,6 +283,8 @@ record_route_preset("1.2.3.4:5090");
277 283
      * param - String containing the URI parameter to be added.
278 284
        It must follow the ";name=value" scheme.
279 285
 
286
+   This function can be used from REQUEST_ROUTE.
287
+
280 288
    Example 1-10. add_rr_param usage
281 289
 ...
282 290
 add_rr_param(";nat=yes");
... ...
@@ -295,6 +303,8 @@ add_rr_param(";nat=yes");
295 303
      * re - regular expression to check against the Route URI
296 304
        parameters.
297 305
 
306
+   This function can be used from REQUEST_ROUTE.
307
+
298 308
    Example 1-11. check_route_param usage
299 309
 ...
300 310
 if (check_route_param("nat=yes")) {
... ...
@@ -323,6 +333,8 @@ if (check_route_param("nat=yes")) {
323 333
        may be "upstream" (from UAS to UAC) or "downstream" (UAC
324 334
        to UAS).
325 335
 
336
+   This function can be used from REQUEST_ROUTE.
337
+
326 338
    Example 1-12. check_route_param usage
327 339
 ...
328 340
 if (is_direction("upstream")) {
... ...
@@ -223,6 +223,9 @@ modparam("rr", "add_username", 1)
223 223
 		The function performs loose routing as defined in &rfc3261;.
224 224
 		See the &rfc3261; for more details.
225 225
 		</para>
226
+		<para>
227
+		This function can be used from REQUEST_ROUTE.
228
+		</para>
226 229
 		<example>
227 230
 		<title><function>loose_route</function> usage</title>
228 231
 		<programlisting format="linespecific">
... ...
@@ -261,6 +264,9 @@ strict_route();
261 264
 		will be inserted in the message before any other Record-Route header 
262 265
 		fields.
263 266
 		</para>
267
+		<para>
268
+		This function can be used from REQUEST_ROUTE.
269
+		</para>
264 270
 		<example>
265 271
 		<title><function>record_route</function> usage</title>
266 272
 		<programlisting format="linespecific">
... ...
@@ -288,6 +294,9 @@ record_route();
288 294
 			</para>
289 295
 		</listitem>
290 296
 		</itemizedlist>
297
+		<para>
298
+		This function can be used from REQUEST_ROUTE.
299
+		</para>
291 300
 		<example>
292 301
 		<title><function>record_route_preset</function> usage</title>
293 302
 		<programlisting format="linespecific">
... ...
@@ -317,6 +326,9 @@ record_route_preset("1.2.3.4:5090");
317 326
 			</para>
318 327
 		</listitem>
319 328
 		</itemizedlist>
329
+		<para>
330
+		This function can be used from REQUEST_ROUTE.
331
+		</para>
320 332
 		<example>
321 333
 		<title><function>add_rr_param</function> usage</title>
322 334
 		<programlisting format="linespecific">
... ...
@@ -345,6 +357,9 @@ add_rr_param(";nat=yes");
345 357
 			</para>
346 358
 		</listitem>
347 359
 		</itemizedlist>
360
+		<para>
361
+		This function can be used from REQUEST_ROUTE.
362
+		</para>
348 363
 		<example>
349 364
 		<title><function>check_route_param</function> usage</title>
350 365
 		<programlisting format="linespecific">
... ...
@@ -385,6 +400,9 @@ if (check_route_param("nat=yes")) {
385 400
 			</para>
386 401
 		</listitem>
387 402
 		</itemizedlist>
403
+		<para>
404
+		This function can be used from REQUEST_ROUTE.
405
+		</para>
388 406
 		<example>
389 407
 		<title><function>check_route_param</function> usage</title>
390 408
 		<programlisting format="linespecific">
... ...
@@ -98,6 +98,8 @@ Chapter 1. User's Guide
98 98
      * code - Return code.
99 99
      * reason - Reason phrase.
100 100
 
101
+   This function can be used from REQUEST_ROUTE.
102
+
101 103
    Example 1-1. sl_send_reply usage
102 104
 ...
103 105
 sl_send_reply("404", "Not found");
... ...
@@ -110,6 +112,8 @@ sl_send_reply("404", "Not found");
110 112
    internal error. Usually this function should be used after a
111 113
    script function that returned an error code.
112 114
 
115
+   This function can be used from REQUEST_ROUTE.
116
+
113 117
    Example 1-2. sl_reply_error usage
114 118
 ...
115 119
 sl_reply_error();
... ...
@@ -138,9 +142,9 @@ Chapter 3. Frequently Asked Questions
138 142
    one of our mailing lists:
139 143
 
140 144
      * User Mailing List -
141
-       http://openser.org/mailman/listinfo/users
145
+       http://openser.org/cgi-bin/mailman/listinfo/users
142 146
      * Developer Mailing List -
143
-       http://openser.org/mailman/listinfo/devel
147
+       http://openser.org/cgi-bin/mailman/listinfo/devel
144 148
 
145 149
    E-mails regarding any stable OpenSER release should be sent to
146 150
    <users@openser.org> and e-mails regarding development versions
... ...
@@ -91,6 +91,9 @@
91 91
 		    </para>
92 92
 		</listitem>
93 93
 	    </itemizedlist>
94
+		<para>
95
+		This function can be used from REQUEST_ROUTE.
96
+		</para>
94 97
 	    <example>
95 98
 		<title><function>sl_send_reply</function> usage</title>
96 99
 		<programlisting format="linespecific">
... ...
@@ -109,6 +112,9 @@ sl_send_reply("404", "Not found");
109 112
 		Sends back an error reply describing the nature of the last internal error.  Usually
110 113
 		this function should be used after a script function that returned an error code.
111 114
 	    </para>
115
+		<para>
116
+		This function can be used from REQUEST_ROUTE.
117
+		</para>
112 118
 	    <example>
113 119
 		<title><function>sl_reply_error</function> usage</title>
114 120
 		<programlisting format="linespecific">
... ...
@@ -313,6 +313,8 @@ modparam("sms", "sms_report_type", 1)
313 313
 
314 314
      * network_name - Name of network.
315 315
 
316
+   This function can be used from REQUEST_ROUTE.
317
+
316 318
    Example 1-9. sms_send_msg_to_net usage
317 319
 ...
318 320
 if (sms_send_msg_to_net("D1"))
... ...
@@ -338,6 +340,8 @@ if (sms_send_msg_to_net("D1"))
338 340
    The same as the previous one, but use the default network
339 341
    queue.
340 342
 
343
+   This function can be used from REQUEST_ROUTE.
344
+
341 345
    Example 1-10. sms_send_msg usage
342 346
 ...
343 347
 if (sms_send_msg_to_net())
... ...
@@ -381,9 +385,9 @@ Chapter 3. Frequently Asked Questions
381 385
    one of our mailing lists:
382 386
 
383 387
      * User Mailing List -
384
-       http://openser.org/mailman/listinfo/users
388
+       http://openser.org/cgi-bin/mailman/listinfo/users
385 389
      * Developer Mailing List -
386
-       http://openser.org/mailman/listinfo/devel
390
+       http://openser.org/cgi-bin/mailman/listinfo/devel
387 391
 
388 392
    E-mails regarding any stable OpenSER release should be sent to
389 393
    <users@openser.org> and e-mails regarding development versions
... ...
@@ -393,6 +393,9 @@ modparam("sms", "sms_report_type", 1)
393 393
 		    </para>
394 394
 		</listitem>
395 395
 	    </itemizedlist>
396
+		<para>
397
+		This function can be used from REQUEST_ROUTE.
398
+		</para>
396 399
 	    <example>
397 400
 		<title><function>sms_send_msg_to_net</function> usage</title>
398 401
 		<programlisting format="linespecific">
... ...
@@ -424,6 +427,9 @@ if (sms_send_msg_to_net("D1"))
424 427
 	    <para>
425 428
 		The same as the previous one, but use the default network queue.
426 429
 	    </para>
430
+		<para>
431
+		This function can be used from REQUEST_ROUTE.
432
+		</para>
427 433
 	    <example>
428 434
 		<title><function>sms_send_msg</function> usage</title>
429 435
 		<programlisting format="linespecific">
... ...
@@ -207,6 +207,8 @@ modparam("speeddial", "use_domain", 1)
207 207
      * table - The name of the table storing the speed dial
208 208
        records.
209 209
 
210
+   This function can be used from REQUEST_ROUTE.
211
+
210 212
    Example 1-9. sd_lookup usage
211 213
 ...
212 214
 if(uri=~"sip:[0-9]{2}@.*")
... ...
@@ -376,9 +378,9 @@ Chapter 3. Frequently Asked Questions
376 378
    answered on one of OpenSER mailing lists:
377 379
 
378 380
      * User Mailing List -
379
-       http://openser.org/mailman/listinfo/users
381
+       http://openser.org/cgi-bin/mailman/listinfo/users
380 382
      * Developer Mailing List -
381
-       http://openser.org/mailman/listinfo/devel
383
+       http://openser.org/cgi-bin/mailman/listinfo/devel
382 384
 
383 385
    3.2. How can I report a bug?
384 386
 
... ...
@@ -233,6 +233,9 @@ modparam("speeddial", "use_domain", 1)
233 233
 		    </para>
234 234
 		</listitem>
235 235
 	    </itemizedlist>
236
+		<para>
237
+		This function can be used from REQUEST_ROUTE.
238
+		</para>
236 239
 	    <example>
237 240
 		<title><function>sd_lookup</function> usage</title>
238 241
 		<programlisting format="linespecific">
... ...
@@ -134,6 +134,8 @@ modparam("uac","credential","username:domain:password")
134 134
 
135 135
    display and URI parameters can include pseudo-variables.
136 136
 
137
+   This function can be used from REQUEST_ROUTE.
138
+
137 139
    Example 1-4. uac_replace_from usage
138 140
 ...
139 141
 uac_replace_from("$avp(s:display)","$avp(s:uri)");
... ...
@@ -150,6 +152,8 @@ uac_replace_from("batman","");
150 152
 
151 153
    URI parameter can include pseudo-variables.
152 154
 
155
+   This function can be used from REQUEST_ROUTE.
156
+
153 157
    Example 1-5. uac_replace_from usage
154 158
 ...
155 159
 uac_replace_from("sip:batman@gotham.org");
... ...
@@ -162,6 +166,8 @@ uac_replace_from("sip:batman@gotham.org");
162 166
    use the information stored in header parameter to restore the
163 167
    original FROM URI value.
164 168
 
169
+   This function can be used from REQUEST_ROUTE.
170
+
165 171
    Example 1-6. uac_restore_from usage
166 172
 ...
167 173
 uac_restore_from();
... ...
@@ -174,6 +180,8 @@ uac_restore_from();
174 180
    build the authentication response header and insert it into
175 181
    the request without sending anything.
176 182
 
183
+   This function can be used from FAILURE_ROUTE.
184
+
177 185
    Example 1-7. uac_auth usage
178 186
 ...
179 187
 uac_auth();
... ...
@@ -202,9 +210,9 @@ Chapter 3. Frequently Asked Questions
202 210
    one of our mailing lists:
203 211
 
204 212
      * User Mailing List -
205
-       http://openser.org/mailman/listinfo/users
213
+       http://openser.org/cgi-bin/mailman/listinfo/users
206 214
      * Developer Mailing List -
207
-       http://openser.org/mailman/listinfo/devel
215
+       http://openser.org/cgi-bin/mailman/listinfo/devel
208 216
 
209 217
    E-mails regarding any stable version should be sent to
210 218
    <users@openser.org> and e-mail regarding development versions
... ...
@@ -165,6 +165,9 @@ modparam("uac","credential","username:domain:password")
165 165
 			<emphasis>display</emphasis> and <emphasis>URI</emphasis> parameters
166 166
 			can include pseudo-variables.
167 167
 			</para>
168
+			<para>
169
+			This function can be used from REQUEST_ROUTE.
170
+			</para>
168 171
 			<example>
169 172
 				<title><function>uac_replace_from</function> usage</title>
170 173
 				<programlisting format="linespecific">
... ...
@@ -188,6 +191,9 @@ uac_replace_from("batman","");
188 191
 			<para>
189 192
 			<emphasis>URI</emphasis> parameter can include pseudo-variables.
190 193
 			</para>
194
+			<para>
195
+			This function can be used from REQUEST_ROUTE.
196
+			</para>
191 197
 			<example>
192 198
 				<title><function>uac_replace_from</function> usage</title>
193 199
 				<programlisting format="linespecific">
... ...
@@ -206,6 +212,9 @@ uac_replace_from("sip:batman@gotham.org");
206 212
 			use the information stored in header parameter to restore
207 213
 			the original FROM URI value.
208 214
 			</para>
215
+			<para>
216
+			This function can be used from REQUEST_ROUTE.
217
+			</para>
209 218
 			<example>
210 219
 				<title><function>uac_restore_from</function> usage</title>
211 220
 				<programlisting format="linespecific">
... ...
@@ -224,6 +233,9 @@ uac_restore_from();
224 233
 			build the authentication response header and insert it into the
225 234
 			request without sending anything.
226 235
 			</para>
236
+			<para>
237
+			This function can be used from FAILURE_ROUTE.
238
+			</para>
227 239
 			<example>
228 240
 				<title><function>uac_auth</function> usage</title>
229 241
 				<programlisting format="linespecific">
... ...
@@ -237,6 +237,8 @@ modparam("uac_redirect","acc_db_table","acc_redirect")
237 237
      * reset_added - reset only the previous added deny filters;
238 238
      * empty - no reset, just add the filter.
239 239
 
240
+   This function can be used from FAILURE_ROUTE.
241
+
240 242
    Example 1-6. set_deny_filter usage
241 243
 ...
242 244
 set_deny_filter(".*@domain2.net","reset_all");
... ...
@@ -260,6 +262,8 @@ set_deny_filter(".*@domain1.net","");
260 262
        filters;
261 263
      * empty - no reset, just add the filter.
262 264
 
265
+   This function can be used from FAILURE_ROUTE.
266
+
263 267
    Example 1-7. set_accept_filter usage
264 268
 ...
265 269
 set_accept_filter(".*@domain2.net","reset_added");
... ...
@@ -289,6 +293,8 @@ set_accept_filter(".*@domain1.net","");
289 293
 
290 294
    This function will produce no accounting records.
291 295
 
296
+   This function can be used from FAILURE_ROUTE.
297
+
292 298
    Example 1-8. get_redirects usage
293 299
 ...
294 300
 # max 2 contacts per branch, but no overall limit
... ...
@@ -312,6 +318,8 @@ get_redirects("*");
312 318
    If this function appears in the script, at startup, the module
313 319
    will import the accounting function. Otherwise not.
314 320
 
321
+   This function can be used from FAILURE_ROUTE.
322
+
315 323
    Example 1-9. get_redirects usage
316 324
 ...
317 325
 get_redirects("4:1","Redirected");
... ...
@@ -387,9 +395,9 @@ Chapter 3. Frequently Asked Questions
387 395
    one of our mailing lists:
388 396
 
389 397
      * User Mailing List -
390
-       http://openser.org/mailman/listinfo/users
398
+       http://openser.org/cgi-bin/mailman/listinfo/users
391 399
      * Developer Mailing List -
392
-       http://openser.org/mailman/listinfo/devel
400
+       http://openser.org/cgi-bin/mailman/listinfo/devel
393 401
 
394 402
    E-mails regarding any stable version should be sent to
395 403
    <users@openser.org> and e-mail regarding development versions
... ...
@@ -318,6 +318,9 @@ modparam("uac_redirect","acc_db_table","acc_redirect")
318 318
 				</para>
319 319
 				</listitem>
320 320
 			</itemizedlist>
321
+			<para>
322
+			This function can be used from FAILURE_ROUTE.
323
+			</para>
321 324
 			<example>
322 325
 				<title><function>set_deny_filter</function> usage</title>
323 326
 				<programlisting format="linespecific">
... ...
@@ -365,6 +368,9 @@ set_deny_filter(".*@domain1.net","");
365 368
 				</para>
366 369
 				</listitem>
367 370
 			</itemizedlist>
371
+			<para>
372
+			This function can be used from FAILURE_ROUTE.
373
+			</para>
368 374
 			<example>
369 375
 				<title><function>set_accept_filter</function> usage</title>
370 376
 				<programlisting format="linespecific">
... ...
@@ -415,6 +421,9 @@ set_accept_filter(".*@domain1.net","");
415 421
 			<para>
416 422
 				This function will produce no accounting records.
417 423
 			</para>
424
+			<para>
425
+				This function can be used from FAILURE_ROUTE.
426
+			</para>
418 427
 			<example>
419 428
 				<title><function>get_redirects</function> usage</title>
420 429
 				<programlisting format="linespecific">
... ...
@@ -449,6 +458,9 @@ get_redirects("*");
449 458
 				If this function appears in the script, at startup, the module
450 459
 				will import the accounting function. Otherwise not.
451 460
 			</para>
461
+			<para>
462
+			This function can be used from FAILURE_ROUTE.
463
+			</para>
452 464
 			<example>
453 465
 				<title><function>get_redirects</function> usage</title>
454 466
 				<programlisting format="linespecific">
... ...
@@ -139,6 +139,9 @@ modparam("xlog", "force_color", 0)
139 139
        'L_ERR'.
140 140
      * format - The formatted string to be printed.
141 141
 
142
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
143
+   ONREPLY_ROUTE, BRANCH_ROUTE.
144
+
142 145
    Example 1-3. xlog usage
143 146
 ...
144 147
 xlog("L_ERR", "time [$Tf] method <$rm> r-uri <$ru> 2nd via <$hdr(via[1]
... ...
@@ -154,6 +157,9 @@ xlog("L_ERR", "time [$Tf] method <$rm> r-uri <$ru> 2nd via <$hdr(via[1]
154 157
 
155 158
      * format - The formatted string to be printed.
156 159
 
160
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
161
+   ONREPLY_ROUTE, BRANCH_ROUTE.
162
+
157 163
    Example 1-4. xdbg usage
158 164
 ...
159 165
 xdbg("time $Cbx[$Tf]$Cxx method <$rm> r-uri <$ru>\n");
... ...
@@ -191,6 +191,9 @@ modparam("xlog", "force_color", 0)
191 191
 		    </para>
192 192
 		</listitem>
193 193
 	    </itemizedlist>
194
+		<para>
195
+		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE.
196
+		</para>
194 197
 	    <example>
195 198
 		<title><function>xlog</function> usage</title>
196 199
 		<programlisting format="linespecific">
... ...
@@ -215,6 +218,10 @@ xlog("L_ERR", "time [$Tf] method <$rm> r-uri <$ru> 2nd via <$hdr(via[1])>\n");
215 218
 		    </para>
216 219
 		</listitem>
217 220
 	    </itemizedlist>
221
+		<para>
222
+		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE.
223
+		</para>
224
+
218 225
 	    <example>
219 226
 		<title><function>xdbg</function> usage</title>
220 227
 		<programlisting format="linespecific">