Browse code

drouting: readme regenerated

Daniel-Constantin Mierla authored on 17/12/2015 09:23:57
Showing 1 changed files
... ...
@@ -10,7 +10,7 @@ Edited by
10 10
 
11 11
 Anca-Maria Vamanu
12 12
 
13
-   Copyright © 2005-2008 Voice Sistem SRL
13
+   Copyright � 2005-2008 Voice Sistem SRL
14 14
      __________________________________________________________________
15 15
 
16 16
    Table of Contents
... ...
@@ -234,7 +234,7 @@ Chapter 1. Admin Guide
234 234
 
235 235
 1.4.1. Gateway Addresses
236 236
 
237
-   Default name for the table storing gateway addresses is “dr_gateways”.
237
+   Default name for the table storing gateway addresses is "dr_gateways".
238 238
    Gateway addresses are stored in a separate table because of need to
239 239
    access them independent of Dynamic Routing processing (e.g., adding/
240 240
    removing gateway PRI prefix before/after performing other operation --
... ...
@@ -270,12 +270,12 @@ Chapter 1. Admin Guide
270 270
    group of destinations is delimited by semi-colon char. inside the whole
271 271
    destination list ( like: 2,4;5,78,23;4;7;2 ). The destinations from
272 272
    within a group may be act differently (like load-balancing, random
273
-   selection, etc), depending of the “sort_order” module parameter - more
273
+   selection, etc), depending of the "sort_order" module parameter - more
274 274
    about this is available under the module paramters section.
275 275
 
276 276
 1.4.3. Routing Rules
277 277
 
278
-   Default name for the table storing rule definitions is “dr_rules”.
278
+   Default name for the table storing rule definitions is "dr_rules".
279 279
 
280 280
    Table 1.3. Definition of dr_rules table
281 281
    Column name     Type     Default            Description
... ...
@@ -304,18 +304,18 @@ Chapter 1. Admin Guide
304 304
        draft 09):
305 305
        Table 1.4. Time recurrence attributes
306 306
 
307
-     Attribute                            Description
308
-     dastard    Start of interval (RFC 2445 DATE-TIME)
309
-     duration   Length of interval (RFC 2445 DURATION)
310
-     freq       Frequency of recurrence (secondly,minutely,hourly, daily,weekly,
311
-                monthly, or yearly).
312
-     until      bound of recurrence (RFC 2445 DATE-TIME)
313
-     interval   How often the recurrence repeats
314
-     byday      List of days of the week
315
-     bymonthday List of days of the month
316
-     byyearday  List of days of the year
317
-     byweekno   List of weeks of the year
318
-     bymonth    List of months of the year
307
+   Attribute Description
308
+   dastard Start of interval (RFC 2445 DATE-TIME)
309
+   duration Length of interval (RFC 2445 DURATION)
310
+   freq Frequency of recurrence (secondly,minutely,hourly, daily,weekly,
311
+   monthly, or yearly).
312
+   until bound of recurrence (RFC 2445 DATE-TIME)
313
+   interval How often the recurrence repeats
314
+   byday List of days of the week
315
+   bymonthday List of days of the month
316
+   byyearday List of days of the year
317
+   byweekno List of weeks of the year
318
+   bymonth List of months of the year
319 319
        The value stored in database has the format of:
320 320
        <dtstart>|<duration>|<freq>|<until>|<interval>|<byday>|<bymonthday>
321 321
        |<byyearday>|<byweekno>|<bymonth>
... ...
@@ -325,48 +325,52 @@ Chapter 1. Admin Guide
325 325
        Detailed description of time recurrence attributes:
326 326
           + dtstart - specifies the beginning of the first period.
327 327
           + duration - specifies the duration of the period. For a
328
-            recurring interval, the “duration” parameter MUST be small
328
+            recurring interval, the "duration" parameter MUST be small
329 329
             enough such that subsequent intervals do not overlap. For
330 330
             non-recurring intervals, durations of any positive length are
331
-            permitted, zero-length duration means “forever”.
332
-            Negative-length durations are not allowed.
333
-          + freq - takes one of the following values: “daily”, to specify
331
+            permitted, zero-length duration means "forever".
332
+            Negative-length durations are not allowed. In the common case
333
+            of a duration less than one day, the value starts with 'PT'
334
+            followed by number of hours, minutes and seconds, e.g., a
335
+            duration of 8 hours and 30 minutes is written 'PT8H30M'. See
336
+            RFC 2445 DURATION specifications for full format.
337
+          + freq - takes one of the following values: "daily", to specify
334 338
             repeating periods based on an interval of a day or more;
335
-            “weekly”, to specify repeating periods based on an interval of
336
-            a week or more; “monthly”, to specify repeating periods based
337
-            on an interval of a month or more; and “yearly”, to specify
339
+            "weekly", to specify repeating periods based on an interval of
340
+            a week or more; "monthly", to specify repeating periods based
341
+            on an interval of a month or more; and "yearly", to specify
338 342
             repeating periods based on an interval of a year or more.
339 343
             These values are not case-sensitive.
340 344
           + until - defines an iCalendar COS DATE or DATE-TIME value which
341 345
             bounds the recurrence rule in an inclusive manner. If the
342
-            value specified by “until” is synchronized with the specified
346
+            value specified by "until" is synchronized with the specified
343 347
             recurrence, this date or date-time becomes the last instance
344 348
             of the recurrence. If not present, the recurrence is
345 349
             considered to repeat forever.
346 350
           + interval - contains a positive integer representing how often
347
-            the recurrence rule repeats. The default value is “1”, meaning
348
-            every day for a “daily” rule, every week for a “weekly” rule,
349
-            every month for a “monthly” rule and every year for a “yearly”
351
+            the recurrence rule repeats. The default value is "1", meaning
352
+            every day for a "daily" rule, every week for a "weekly" rule,
353
+            every month for a "monthly" rule and every year for a "yearly"
350 354
             rule.
351 355
           + interval - contains a positive integer representing how often
352
-            the recurrence rule repeats. The default value is “1”, meaning
353
-            every day for a “daily” rule, every week for a “weekly” rule,
354
-            every month for a “monthly” rule and every year for a “yearly”
356
+            the recurrence rule repeats. The default value is "1", meaning
357
+            every day for a "daily" rule, every week for a "weekly" rule,
358
+            every month for a "monthly" rule and every year for a "yearly"
355 359
             rule.
356 360
           + byday - specifies a comma-separated list of days of the week.
357
-            “MO” indicates Monday; “TU” indicates Tuesday; “WE” indicates
358
-            Wednesday; “TH” indicates Thursday; “FR” indicates Friday;
359
-            “SA” indicates Saturday; “SU” indicates Sunday. These values
361
+            "MO" indicates Monday; "TU" indicates Tuesday; "WE" indicates
362
+            Wednesday; "TH" indicates Thursday; "FR" indicates Friday;
363
+            "SA" indicates Saturday; "SU" indicates Sunday. These values
360 364
             are not case-sensitive.
361
-            Each “byday” value can also be preceded by a positive (+n) or
365
+            Each "byday" value can also be preceded by a positive (+n) or
362 366
             negative (-n) integer. If present, this indicates the nth
363
-            occurrence of the specific day within the “monthly” or
364
-            “yearly” recurrence. For example, within a “monthly” rule,
367
+            occurrence of the specific day within the "monthly" or
368
+            "yearly" recurrence. For example, within a "monthly" rule,
365 369
             +1MO (or simply 1MO) represents the first Monday within the
366 370
             month, whereas -1MO represents the last Monday of the month.
367 371
             If an integer modifier is not present, it means all days of
368 372
             this type within the specified frequency. For example, within
369
-            a “monthly” rule, MO represents all Mondays within the month.
373
+            a "monthly" rule, MO represents all Mondays within the month.
370 374
           + bymonthday - parameter specifies a comma-separated list of
371 375
             days of the month. Valid values are 1 to 31 or -31 to -1. For
372 376
             example, -10 represents the tenth to the last day of the
... ...
@@ -380,37 +384,37 @@ Chapter 1. Admin Guide
380 384
             to -1.
381 385
           + bymonth - parameter specifies a comma-separated list of months
382 386
             of the year. Valid values are 1 to 12.
383
-       A recurrence is specified by including the “freq” parameter, which
387
+       A recurrence is specified by including the "freq" parameter, which
384 388
        indicates the type of recurrence rule. Parameters other than
385
-       “dtstart” and “duration” SHOULD NOT be specified unless “freq” is
389
+       "dtstart" and "duration" SHOULD NOT be specified unless "freq" is
386 390
        present.
387 391
        If byxxx parameter values are found which are beyond the available
388
-       scope (ie, bymonthday=“30” in February), they are simply ignored.
392
+       scope (ie, bymonthday="30" in February), they are simply ignored.
389 393
        Byxxx parameters modify the recurrence in some manner. Byxxx rule
390 394
        parts for a period of time which is the same or greater than the
391 395
        frequency generally reduce or limit the number of occurrences of
392
-       the recurrence generated. For example, freq=“daily” bymonth=“1”
396
+       the recurrence generated. For example, freq="daily" bymonth="1"
393 397
        reduces the number of recurrence instances from all days (if the
394
-       “bymonth” parameter is not present) to all days in January. Byxxx
398
+       "bymonth" parameter is not present) to all days in January. Byxxx
395 399
        parameters for a period of time less than the frequency generally
396 400
        increase or expand the number of occurrences of the recurrence. For
397
-       example, freq=“yearly” bymonth=“1,2” increases the number of days
398
-       within the yearly recurrence set from 1 (if “bymonth” parameter is
401
+       example, freq="yearly" bymonth="1,2" increases the number of days
402
+       within the yearly recurrence set from 1 (if "bymonth" parameter is
399 403
        not present) to 2.
400 404
        If multiple Byxxx parameters are specified, then after evaluating
401
-       the specified “freq” and “interval” parameters, the Byxxx
405
+       the specified "freq" and "interval" parameters, the Byxxx
402 406
        parameters are applied to the current set of evaluated occurrences
403
-       in the following order: “bymonth”, “byweekno”, “byyearday”,
404
-       “bymonthday”, “byday”; then “until” is evaluated.
407
+       in the following order: "bymonth", "byweekno", "byyearday",
408
+       "bymonthday", "byday"; then "until" is evaluated.
405 409
        Here is an example of evaluating multiple Byxxx parameters.
406
-       dtstart=“19970105T083000” duration=“10M” freq=“yearly” interval=“2”
407
-       bymonth=“1” byday=“SU”
408
-       First, the interval=“2” would be applied to freq=“yearly” to arrive
409
-       at “every other year” . Then, bymonth=“1” would be applied to
410
-       arrive at “every January, every other year”. Then, byday=“SU” would
411
-       be applied to arrive at “every Sunday in January, every other year,
412
-       from 8:30 to 8:40 ”. The appropriate minutes and hours have been
413
-       retrieved from the “dtstart” and “duration” parameters.
410
+       dtstart="19970105T083000" duration="PT10M" freq="yearly"
411
+       interval="2" bymonth="1" byday="SU"
412
+       First, the interval="2" would be applied to freq="yearly" to arrive
413
+       at "every other year" . Then, bymonth="1" would be applied to
414
+       arrive at "every January, every other year". Then, byday="SU" would
415
+       be applied to arrive at "every Sunday in January, every other year,
416
+       from 8:30 to 8:40 ". The appropriate minutes and hours have been
417
+       retrieved from the "dtstart" and "duration" parameters.
414 418
     d. priority column
415 419
        If many rules are eligible, choose the one with highest priority.
416 420
     e. routeid column
... ...
@@ -420,8 +424,8 @@ Chapter 1. Admin Guide
420 424
        level.
421 425
     f. gwlist column
422 426
        A comma separated list of gateway identifiers corresponding to a
423
-       row in table “dr_gateways”. You can use a predefined list from the
424
-       table “dr_gw_lists” preceded by the character “#”. The first
427
+       row in table "dr_gateways". You can use a predefined list from the
428
+       table "dr_gw_lists" preceded by the character "#". The first
425 429
        gateway is tried first and if routing to it fails, then the second
426 430
        one, and so one. If no gateway is left a negative response is sent
427 431
        back to caller.
... ...
@@ -433,7 +437,7 @@ Chapter 1. Admin Guide
433 437
    2 8 0049 20040101T083000 0 0 1,2 Rule 2
434 438
    3 7,8,9 0049 20040101T083000 0 0 3 Rule 3
435 439
        (The time recurrence for first rule is:
436
-       “20040101T083000|10H|weekly|||MO,TU,WE,TH,FR”)
440
+       "20040101T083000|10H|weekly|||MO,TU,WE,TH,FR")
437 441
 
438 442
 1.5. Routing Rule Processing
439 443
 
... ...
@@ -501,7 +505,7 @@ Chapter 1. Admin Guide
501 505
 
502 506
    The database url.
503 507
 
504
-   Default value is “NULL”.
508
+   Default value is "NULL".
505 509
 
506 510
    Example 1.1. Set db_url parameter
507 511
 ...
... ...
@@ -513,7 +517,7 @@ modparam("drouting", "db_url",
513 517
 
514 518
    The name of the db table storing gateway addresses.
515 519
 
516
-   Default value is “dr_gateways”.
520
+   Default value is "dr_gateways".
517 521
 
518 522
    Example 1.2. Set drd_table parameter
519 523
 ...
... ...
@@ -524,7 +528,7 @@ modparam("drouting", "drd_table", "dr_gateways")
524 528
 
525 529
    The name of the db table storing routing rules.
526 530
 
527
-   Default value is “dr_rules”.
531
+   Default value is "dr_rules".
528 532
 
529 533
    Example 1.3. Set drr_table parameter
530 534
 ...
... ...
@@ -535,7 +539,7 @@ modparam("drouting", "drr_table", "rules")
535 539
 
536 540
    The name of the db table storing groups.
537 541
 
538
-   Default value is “dr_groups”.
542
+   Default value is "dr_groups".
539 543
 
540 544
    Example 1.4. Set drg_table parameter
541 545
 ...
... ...
@@ -550,7 +554,7 @@ modparam("drouting", "drg_table", "groups")
550 554
    individual elements. Very useful to reuse a list of gateways in
551 555
    different places.
552 556
 
553
-   Default value is “dr_gw_lists”.
557
+   Default value is "dr_gw_lists".
554 558
 
555 559
    Example 1.5. Set drl_table parameter
556 560
 ...
... ...
@@ -581,7 +585,7 @@ modparam("drouting", "drl_table", "my_gw_lists")
581 585
        case there are 2 failures, all the three gateways (1,2,3) will be
582 586
        tried in a random order.
583 587
 
584
-   Default value is “0”.
588
+   Default value is "0".
585 589
 
586 590
    Example 1.6. Set sort_order parameter
587 591
 ...
... ...
@@ -593,7 +597,7 @@ modparam("drouting", "sort_order", 2)
593 597
    The name of the avp for storing Request URIs to be later used
594 598
    (alternative destiantions for the current one).
595 599
 
596
-   Default value is “NULL”.
600
+   Default value is "NULL".
597 601
 
598 602
    Example 1.7. Set ruri_avp parameter
599 603
 ...
... ...
@@ -608,7 +612,7 @@ modparam("drouting", "ruri_avp", '$avp(i:33)')
608 612
    function), the AVP will be updated with the attrs of the new used
609 613
    destination.
610 614
 
611
-   Default value is “NULL”.
615
+   Default value is "NULL".
612 616
 
613 617
    Example 1.8. Set attrs_avp parameter
614 618
 ...
... ...
@@ -621,7 +625,7 @@ modparam("drouting", "atrrs_avp", '$avp(i:67)')
621 625
    Flag to configure whether to use domain match when querying database
622 626
    for user's routing group.
623 627
 
624
-   Default value is “1”.
628
+   Default value is "1".
625 629
 
626 630
    Example 1.9. Set use_domain parameter
627 631
 ...
... ...
@@ -632,7 +636,7 @@ modparam("drouting", "use_domain", 0)
632 636
 
633 637
    The name of the column in group db table where the username is stored.
634 638
 
635
-   Default value is “username”.
639
+   Default value is "username".
636 640
 
637 641
    Example 1.10. Set drg_user_col parameter
638 642
 ...
... ...
@@ -643,7 +647,7 @@ modparam("drouting", "drg_user_col", "user")
643 647
 
644 648
    The name of the column in group db table where the domain is stored.
645 649
 
646
-   Default value is “domain”.
650
+   Default value is "domain".
647 651
 
648 652
    Example 1.11. Set drg_domain_col parameter
649 653
 ...
... ...
@@ -654,7 +658,7 @@ modparam("drouting", "drg_domain_col", "host")
654 658
 
655 659
    The name of the column in group db table where the group id is stored.
656 660
 
657
-   Default value is “groupid”.
661
+   Default value is "groupid".
658 662
 
659 663
    Example 1.12. Set drg_grpid_col parameter
660 664
 ...
... ...
@@ -666,7 +670,7 @@ modparam("drouting", "drg_grpid_col", "grpid")
666 670
    The number of rows that should be fetched from the result of a query in
667 671
    rules db table.
668 672
 
669
-   Default value is “2000”.
673
+   Default value is "2000".
670 674
 
671 675
    Example 1.13. Set fetch_rows parameter
672 676
 ...
... ...
@@ -679,7 +683,7 @@ modparam("drouting", "fetch_rows", 1500)
679 683
    startup. If not enabled, the GW name will be blindly used during
680 684
    routing.
681 685
 
682
-   Default value is “1 (enabled)”.
686
+   Default value is "1 (enabled)".
683 687
 
684 688
    Example 1.14. Set force_dns parameter
685 689
 ...
... ...
@@ -694,7 +698,7 @@ modparam("drouting", "force_dns", 0)
694 698
    4.4. is_from_gw([type])
695 699
    4.5. is_from_gw( type, [flag])
696 700
 
697
-4.1.  do_routing("[groupID]")
701
+4.1. do_routing("[groupID]")
698 702
 
699 703
    Function to trigger routing of the message according to the rules in
700 704
    the database table and the configured parameters.
... ...
@@ -714,7 +718,7 @@ do_routing("0");
714 718
 ...
715 719
 do_routing("$avp(i:10)");
716 720
 
717
-4.2.  use_next_gw()/next_routing()
721
+4.2. use_next_gw()/next_routing()
718 722
 
719 723
    The function takes the next available destination (set by do_routing,
720 724
    as alternative destinations) and push it into RURI. Note that the
... ...
@@ -737,7 +741,7 @@ if (use_next_gw()) {
737 741
 }
738 742
 ...
739 743
 
740
-4.3.  goes_to_gw([type])
744
+4.3. goes_to_gw([type])
741 745
 
742 746
    Function returns true if the destination of the current request
743 747
    (destination URI or Request URI) points (as IP) to one of the gateways.
... ...
@@ -758,7 +762,7 @@ if (goes_to_gw("1")) {
758 762
 }
759 763
 ...
760 764
 
761
-4.4.  is_from_gw([type])
765
+4.4. is_from_gw([type])
762 766
 
763 767
    The function checks if the sender of the message is a gateway from a
764 768
    certain group.
... ...
@@ -777,7 +781,7 @@ if (is_from_gw("1") {
777 781
 }
778 782
 ...
779 783
 
780
-4.5.  is_from_gw( type, [flag])
784
+4.5. is_from_gw( type, [flag])
781 785
 
782 786
    The function checks if the sender of the message is a gateway from a
783 787
    certain group.
... ...
@@ -799,7 +803,7 @@ if (is_from_gw("3","1") {
799 803
 
800 804
    5.1. drouting.reload
801 805
 
802
-5.1.  drouting.reload
806
+5.1. drouting.reload
803 807
 
804 808
    Command to reload routing rules from database.
805 809