← Back to branch summary

~ubuntu-branches/debian/sid/kamailio/sid

« back to all changes in this revision

Viewing changes to modules/dispatcher/doc/dispatcher_admin.xml

  • Committer: Package Import Robot
  • Author(s): Victor Seva
  • Date: 2014-01-06 11:47:13 UTC
  • mfrom: (1.1.5)
  • Revision ID: package-import@ubuntu.com-20140106114713-t8xidp4arzrnyeya
Tags: 4.1.1-1
http://bugs.debian.org/728915
* New upstream release
* debian/patches:
  - add upstream fixes
* Added tls outbound websocket autheph dnssec modules
  - openssl exception added to their license
* removing sparc and ia64 from supported archs
  for mono module (Closes: #728915)

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/dispatcher/doc/dispatcher_admin.xml
74
74
 
75
75
        <section>
76
76
        <title>Parameters</title>
77
 
        <section>
 
77
        <section id="dispatcher.p.list_file">
78
78
                <title><varname>list_file</varname> (string)</title>
79
79
                <para>
80
80
                Path to the file with destination sets.
95
95
                </example>
96
96
        </section>
97
97
 
98
 
        <section>
 
98
        <section id="dispatcher.p.db_url">
99
99
                <title><varname>db_url</varname> (string)</title>
100
100
                <para>
101
101
                If you want to load the sets of gateways from the database you must set
116
116
                </example>
117
117
        </section>
118
118
 
119
 
        <section>
 
119
        <section id="dispatcher.p.table_name">
120
120
                <title><varname>table_name</varname> (string)</title>
121
121
                <para>
122
122
                If you want to load the sets of gateways from the database you must set
137
137
                </example>
138
138
        </section>
139
139
 
140
 
        <section>
 
140
        <section id="dispatcher.p.setid_col">
141
141
                <title><varname>setid_col</varname> (string)</title>
142
142
                <para>
143
143
                        The column's name in the database storing the gateway's group id.
157
157
                </example>
158
158
        </section>
159
159
 
160
 
        <section>
 
160
        <section id="dispatcher.p.destination_col">
161
161
                <title><varname>destination_col</varname> (string)</title>
162
162
                <para>
163
163
                        The column's name in the database storing the destination
178
178
                </example>
179
179
        </section>
180
180
 
181
 
        <section>
 
181
        <section id="dispatcher.p.flags_col">
182
182
                <title><varname>flags_col</varname> (string)</title>
183
183
                <para>
184
184
                        The column's name in the database storing the flags for
199
199
                </example>
200
200
        </section>
201
201
 
202
 
        <section>
 
202
        <section id="dispatcher.p.priority_col">
203
203
                <title><varname>priority_col</varname> (string)</title>
204
204
                <para>
205
205
                        The column's name in the database storing the priority for
220
220
                </example>
221
221
        </section>
222
222
 
223
 
        <section>
 
223
        <section id="dispatcher.p.force_dst">
224
224
                <title><varname>force_dst</varname> (int)</title>
225
225
                <para>
226
226
                If set to 1, force overwriting of destination address (outbound proxy)
241
241
</programlisting>
242
242
                </example>
243
243
        </section>
244
 
        <section>
 
244
        <section id="dispatcher.p.flags">
245
245
                <title><varname>flags</varname> (int)</title>
246
246
                <para>
247
247
                Various flags that affect dispatcher's behaviour. The flags are defined
272
272
 </programlisting>
273
273
                </example>
274
274
        </section>
275
 
        <section>
 
275
        <section id="dispatcher.p.use_default">
276
276
                <title><varname>use_default</varname> (int)</title>
277
277
                <para>
278
278
                If the parameter is set to 1, the last address in destination set
294
294
 </programlisting>
295
295
                </example>
296
296
        </section>
297
 
        <section>
 
297
        <section id="dispatcher.p.dst_avp">
298
298
                <title><varname>dst_avp</varname> (str)</title>
299
299
                <para>
300
300
                The name of the avp which will hold the list with addresses, in the
324
324
 </programlisting>
325
325
                </example>
326
326
        </section>
327
 
        <section>
 
327
        <section id="dispatcher.p.grp_avp">
328
328
                <title><varname>grp_avp</varname> (str)</title>
329
329
                <para>
330
330
                The name of the avp storing the group id of the destination set. Good
349
349
 </programlisting>
350
350
                </example>
351
351
        </section>
352
 
        <section>
 
352
        <section id="dispatcher.p.cnt_avp">
353
353
                <title><varname>cnt_avp</varname> (str)</title>
354
354
                <para>
355
355
                The name of the avp storing the number of destination addresses kept in
374
374
 </programlisting>
375
375
                </example>
376
376
        </section>
377
 
        <section>
 
377
        <section id="dispatcher.p.dstid_avp">
378
378
                <title><varname>dstid_avp</varname> (str)</title>
379
379
                <para>
380
380
                The name of the avp storing the destination unique ID used for
400
400
 </programlisting>
401
401
                </example>
402
402
        </section>
403
 
        <section>
 
403
        <section id="dispatcher.p.attrs_avp">
404
404
                <title><varname>attrs_avp</varname> (str)</title>
405
405
                <para>
406
406
                The name of the avp storing destination's attributes value.
421
421
 </programlisting>
422
422
                </example>
423
423
        </section>
424
 
        <section>
 
424
        <section id="dispatcher.p.hash_pvar">
425
425
                <title><varname>hash_pvar</varname> (str)</title>
426
426
                <para>
427
427
                String with PVs used for the hashing algorithm 7.
454
454
 </programlisting>
455
455
                </example>
456
456
        </section>
457
 
        <section>
 
457
        <section id="dispatcher.p.setid_pvname">
458
458
                <title><varname>setid_pvname</varname> (str)</title>
459
459
                <para>
460
460
                The name of the PV where to store the set ID (group ID) when calling
473
473
 ...
474
474
 </programlisting>
475
475
                </example>
476
 
        </section>
477
 
 
478
 
        <section>
 
476
        </section>
 
477
        <section id="dispatcher.p.attrs_pvname">
 
478
                <title><varname>attrs_pvname</varname> (str)</title>
 
479
                <para>
 
480
                The name of the PV where to store the attributes of matching address
 
481
                when calling ds_is_from_list().
 
482
                </para>
 
483
                <para>
 
484
                <emphasis>
 
485
                        Default value is <quote>null</quote> - don't set PV.
 
486
                </emphasis>
 
487
                </para>
 
488
                <example>
 
489
                <title>Set the <quote>attrs_pvname</quote> parameter</title>
 
490
 <programlisting format="linespecific">
 
491
 ...
 
492
 modparam("dispatcher", "attrs_pvname", "$var(attrs)")
 
493
 ...
 
494
 </programlisting>
 
495
                </example>
 
496
        </section>
 
497
        <section id="dispatcher.p.ds_ping_method">
479
498
                <title><varname>ds_ping_method</varname> (string)</title>
480
499
                <para>
481
500
                With this method you can define, with which method you want to probe the gateways.
495
514
 </programlisting>
496
515
                </example>
497
516
        </section>      
498
 
        <section>
 
517
        <section id="dispatcher.p.ds_ping_from">
499
518
                <title><varname>ds_ping_from</varname> (string)</title>
500
519
                <para>
501
520
                With this Method you can define the "From:"-Line for the request, sent to the failed gateways.          
516
535
                </example>
517
536
        </section>      
518
537
 
519
 
        <section>
 
538
        <section id="dispatcher.p.ds_ping_interval">
520
539
                <title><varname>ds_ping_interval</varname> (int)</title>
521
540
                <para>
522
541
                With this parameter you can define the interval for sending a request
539
558
                </example>
540
559
        </section>      
541
560
        
542
 
        <section>
543
 
                <title><varname>ds_probing_threshhold</varname> (int)</title>
 
561
        <section id="dispatcher.p.ds_probing_threshold">
 
562
                <title><varname>ds_probing_threshold</varname> (int)</title>
544
563
                <para>
545
564
                If you want to set a gateway into inactive mode, there can be
546
565
                a specific number of failed requests until it will change from "active"
563
582
 </programlisting>
564
583
                </example>
565
584
        </section>
566
 
        <section>
 
585
        <section id="dispatcher.p.ds_ping_reply_codes">
567
586
                <title><varname>ds_ping_reply_codes</varname> (string)</title>
568
587
                <para>
569
588
                This parameter defines the valid response codes, which are accepted as a valid reply to the PING-Method.
584
603
 </programlisting>
585
604
                </example>
586
605
        </section>      
587
 
        <section>
 
606
        <section id="dispatcher.p.ds_probing_mode">
588
607
                <title><varname>ds_probing_mode</varname> (int)</title>
589
608
                <para>
590
609
                Controls what gateways are tested to see if they are reachable. If set
608
627
                </example>
609
628
        </section>
610
629
 
611
 
        <section>
 
630
        <section id="dispatcher.p.ds_hash_size">
612
631
                <title><varname>ds_hash_size</varname> (int)</title>
613
632
                <para>
614
633
                The value to be used as power of two to set the number of slots
631
650
 </programlisting>
632
651
                </example>
633
652
        </section>
634
 
        <section>
 
653
        <section id="dispatcher.p.ds_hash_expire">
635
654
                <title><varname>ds_hash_expire</varname> (int)</title>
636
655
                <para>
637
656
                Expiration time in seconds to remove the load on a destination if no
651
670
 </programlisting>
652
671
                </example>
653
672
        </section>
654
 
        <section>
 
673
        <section id="dispatcher.p.ds_hash_initexpires">
655
674
                <title><varname>ds_hash_initexpire</varname> (int)</title>
656
675
                <para>
657
676
                Expiration time in seconds to remove the load on a destination if no
672
691
 </programlisting>
673
692
                </example>
674
693
        </section>
675
 
        <section>
 
694
        <section id="dispatcher.p.ds_hash_check_interval">
676
695
                <title><varname>ds_hash_check_interval</varname> (int)</title>
677
696
                <para>
678
697
                Time interval in seconds to scan internal hash table with call load
692
711
 </programlisting>
693
712
                </example>
694
713
        </section>
695
 
        <section>
 
714
        <section id="dispatcher.p.outbound_proxy">
696
715
                <title><varname>outbound_proxy</varname> (str)</title>
697
716
                <para>
698
717
                SIP URI of outbound proxy to be used when sending pings.
716
735
 
717
736
        <section>
718
737
        <title>Functions</title>
719
 
        <section>
 
738
        <section id="dispatcher.f.ds_select_dst">
720
739
                <title>
721
740
                <function moreinfo="none">ds_select_dst(set, alg)</function>
722
741
                </title>
851
870
</programlisting>
852
871
                </example>
853
872
        </section>
854
 
        <section>
 
873
        <section id="dispatcher.f.ds_select_domain">
855
874
                <title>
856
875
                <function moreinfo="none">ds_select_domain(set, alg)</function>
857
876
                </title>
894
913
                This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
895
914
                </para>
896
915
        </section>
897
 
        <section>
 
916
        <section id="dispatcher.f.ds_mark_dst">
898
917
                <title>
899
918
                <function moreinfo="none">ds_mark_dst([state])</function>
900
919
                </title>
955
974
</programlisting>
956
975
                </example>
957
976
        </section>
958
 
        <section>
 
977
        <section  id="dispatcher.f.ds_is_from_list">
959
978
                <title>
960
979
                <function moreinfo="none">ds_is_from_list([groupid])</function>
961
980
                </title>
967
986
                Parameter groupid is optional, when it is missing, then the matching
968
987
                will be done against all addresses in all groups. Upon a match, the
969
988
                variable specified by 'setid_pvname' parameter will be set to groupid
970
 
                of matching address.
 
989
                of matching address and the attributes will be set in variable
 
990
                specified by 'attrs_pvname'. The parameter can be an integer or a
 
991
                variable holding an integer value.
971
992
                </para>
972
993
                <para>
973
994
                        This function can be used from ANY_ROUTE.
983
1004
</programlisting>
984
1005
                </example>
985
1006
        </section>
986
 
        <section>
 
1007
        <section id="dispatcher.f.ds_load_update">
987
1008
                <title>
988
1009
                <function moreinfo="none">ds_load_update()</function>
989
1010
                </title>
1049
1070
 
1050
1071
        <section>
1051
1072
        <title>MI Commands</title>
1052
 
        <section>
 
1073
        <section id="dispatcher.mi.ds_set_state">
1053
1074
                <title>
1054
1075
                <function moreinfo="none">ds_set_state</function>
1055
1076
                </title>
1089
1110
                _empty_line_
1090
1111
                </programlisting>
1091
1112
    </section>
1092
 
        <section>
 
1113
        <section id="dispatcher.mi.ds_list">
1093
1114
                <title>
1094
1115
                <function moreinfo="none">ds_list</function>
1095
1116
                </title>
1108
1129
                _empty_line_
1109
1130
                </programlisting>
1110
1131
    </section>
1111
 
        <section>
 
1132
        <section id="dispatcher.mi.ds_reload">
1112
1133
                <title>
1113
1134
                <function moreinfo="none">ds_reload</function>
1114
1135
                </title>
1135
1156
 
1136
1157
        <section>
1137
1158
        <title>Exported RPC Commands</title>
1138
 
        <section>
 
1159
        <section id="dispatcher.rpc.set_state">
1139
1160
                <title>
1140
1161
                <function moreinfo="none">dispatcher.set_state</function>
1141
1162
                </title>
1174
1195
...
1175
1196
</programlisting>
1176
1197
    </section>
1177
 
        <section>
 
1198
        <section id="dispatcher.rpc.list">
1178
1199
                <title>
1179
1200
                <function moreinfo="none">dispatcher.list</function>
1180
1201
                </title>
1192
1213
                &sercmd; dispatcher.list
1193
1214
                </programlisting>
1194
1215
    </section>
1195
 
        <section>
 
1216
        <section id="dispatcher.f.reload">
1196
1217
                <title>
1197
1218
                <function moreinfo="none">dispatcher.reload</function>
1198
1219
                </title>