← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/cfgutils/doc/cfgutils_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/cfgutils/doc/cfgutils_admin.xml
92
92
    </section>
93
93
    <section>
94
94
        <title>Parameters</title>
95
 
        <section>
 
95
        <section id="cfgutils.p.initial_propability">
96
96
                <title><varname>initial_probability</varname> (string)</title>
97
97
                <para>
98
98
                The initial value of the probability.
111
111
            </example>
112
112
        </section>
113
113
 
114
 
        <section>
 
114
        <section id="cfgutils.p.hash_file">
115
115
                <title><varname>hash_file</varname> (string)</title>
116
116
                <para>
117
117
                The config file name for that a hash value should be calculated on startup.
130
130
            </example>
131
131
        </section>
132
132
 
133
 
                <section>
 
133
                <section id="cfgutils.p.initial_gflags">
134
134
                <title><varname>initial_gflags</varname> (integer)</title>
135
135
                <para>
136
136
                The initial value of global flags bitmap.
145
145
                </programlisting>
146
146
                </example>
147
147
        </section>
148
 
                <section>
 
148
                <section id="cfgutils.p.lock_set_size">
149
149
                <title><varname>lock_set_size</varname> (integer)</title>
150
150
                <para>
151
151
                Size of lock set - the value is used as power of two to compute the
165
165
 
166
166
    <section>
167
167
        <title>Functions</title>
168
 
        <section>
 
168
        <section  id="cfgutils.f.rand_event">
169
169
                <title><function moreinfo="none">rand_event()</function></title>
170
170
                <para>
171
171
                        Return true or false, depending on a random value and a
186
186
                </example>
187
187
        </section>
188
188
        
189
 
        <section>
 
189
        <section id="cfgutils.f.rand_set_prob">
190
190
            <title><function moreinfo="none">rand_set_prob(probabiltiy)</function></title>
191
191
            <para>
192
192
                Set the <quote>probability</quote> of the decision.
204
204
            </example>
205
205
        </section>
206
206
 
207
 
        <section>
 
207
        <section id="cfgutils.f.rand_reset_prob">
208
208
            <title><function moreinfo="none">rand_reset_prob()</function></title>
209
209
            <para>
210
210
                Reset the probability back to the inital value.
219
219
            </example>
220
220
        </section>
221
221
 
222
 
        <section>
 
222
        <section id="cfgutils.f.rand_get_prob">
223
223
            <title><function moreinfo="none">rand_get_prob()</function></title>
224
224
            <para>
225
225
                Return the current probability setting, e.g. for logging purposes.
233
233
</programlisting>
234
234
            </example>
235
235
        </section>
236
 
        <section>
 
236
        <section id="cfgutils.f.sleep">
237
237
                <title>
238
238
                        <function moreinfo="none">sleep(time)</function>
239
239
                </title>
261
261
                </example>
262
262
        </section>
263
263
        
264
 
        <section>
 
264
        <section id="cfgutils.f.usleep">
265
265
                <title>
266
266
                        <function moreinfo="none">usleep(time)</function>
267
267
                </title>
291
291
                </example>
292
292
        </section>
293
293
        
294
 
        <section>
 
294
        <section id="cfgutils.f.abort">
295
295
                <title>
296
296
                        <function moreinfo="none">abort()</function>
297
297
                </title>
313
313
                </example>
314
314
        </section>
315
315
        
316
 
        <section>
 
316
        <section id="cfgutils.f.pkg_status">
317
317
                <title>
318
318
                        <function moreinfo="none">pkg_status()</function>
319
319
                </title>
337
337
                </example>
338
338
        </section>
339
339
        
340
 
        <section>
 
340
        <section id="cfgutils.f.pkg_summary">
341
341
                <title>
342
342
                        <function moreinfo="none">pkg_summary()</function>
343
343
                </title>
361
361
                </example>
362
362
        </section>
363
363
        
364
 
        <section>
 
364
        <section id="cfgutils.f.shm_status">
365
365
                <title>
366
366
                        <function moreinfo="none">shm_status()</function>
367
367
                </title>
385
385
                </example>
386
386
        </section>
387
387
 
388
 
        <section>
 
388
        <section  id="cfgutils.f.shm_summary">
389
389
                <title>
390
390
                        <function moreinfo="none">shm_summary()</function>
391
391
                </title>
409
409
                </example>
410
410
        </section>
411
411
        
412
 
        <section>
 
412
        <section id="cfgutils.f.set_gflag">
413
413
                <title><function moreinfo="none">set_gflag(flag)</function></title>
414
414
                <para>
415
415
                Set the bit at the position <quote>flag</quote> in global flags.
431
431
                </example>
432
432
        </section>
433
433
 
434
 
        <section>
 
434
        <section id="cfgutils.f.reset_gflag">
435
435
                <title><function moreinfo="none">reset_gflag(flag)</function></title>
436
436
                <para>
437
437
                Reset the bit at the position <quote>flag</quote> in global flags.
453
453
                </example>
454
454
        </section>
455
455
 
456
 
        <section>
 
456
        <section id="cfgutils.f.is_gflag">
457
457
                <title><function moreinfo="none">is_gflag(flag)</function></title>
458
458
                <para>
459
459
                Check if bit at the position <quote>flag</quote> in global flags is
480
480
</programlisting>
481
481
                </example>
482
482
        </section>
483
 
        <section>
 
483
        <section id="cfgutils.f.lock">
484
484
                <title><function moreinfo="none">lock(key)</function></title>
485
485
                <para>
486
486
                Lock the key. Can be used to syncronize operations in config file,
505
505
</programlisting>
506
506
                </example>
507
507
        </section>
508
 
        <section>
 
508
        <section id="cfgutils.f.unlock">
509
509
                <title><function moreinfo="none">unlock(key)</function></title>
510
510
                <para>
511
511
                Unlock the key.
526
526
</programlisting>
527
527
                </example>
528
528
        </section>
529
 
        <section>
 
529
        <section id="cfgutils.f.check_route_exists">
 
530
                <title><function moreinfo="none">check_route_exists(route)</function></title>
 
531
                <para>
 
532
                Check if a route block exists
 
533
                </para>
 
534
                <para>Parameters:</para>
 
535
                <para>
 
536
                <quote>name</quote> of a route block in the config file, like <quote>route[FROGJUMP]</quote>
 
537
                </para>
 
538
                <para>
 
539
                This function can be used from any route. You can only check for
 
540
                route[] blocks, not reply, event or other routes.
 
541
                </para>
 
542
                <example>
 
543
                <title><function moreinfo="none">check_route_exists()</function> usage</title>
 
544
                <programlisting format="linespecific">
 
545
...
 
546
if(check_route_exists("FROGJUMP") {
 
547
        $var(jumping_frogs) = 1;
 
548
};
 
549
...
 
550
</programlisting>
 
551
                </example>
 
552
        </section>
 
553
        <section id="cfgutils.f.route_if_exists">
 
554
                <title><function moreinfo="none">route_if_exists(route)</function></title>
 
555
                <para>
 
556
                Execute a routing block only if it is defined. If it's not defined, silently
 
557
                move to the next action in the configuration script.
 
558
                </para>
 
559
                <para>Parameters:</para>
 
560
                <para>
 
561
                <quote>name</quote> of a route block in the config file, like <quote>route[FROGJUMP]</quote>
 
562
                </para>
 
563
                <para>
 
564
                This function can be used from any route. You can only execute it for
 
565
                route[] blocks, not reply, event or other routes.
 
566
                </para>
 
567
                <example>
 
568
                <title><function moreinfo="none">route_if_exists()</function> usage</title>
 
569
                <programlisting format="linespecific">
 
570
...
 
571
route_if_exists("PRESENCE_SANTA_CLAUS");
 
572
...
 
573
</programlisting>
 
574
                </example>
 
575
        </section>
 
576
        <section id="cfgutils.f.core_hash">
530
577
                <title><function moreinfo="none">core_hash(string1, string2, size)</function></title>
531
578
                <para>
532
579
                Exported function that enables the core_hash() function to be used
572
619
                        should be changed as in the functions available in the routing
573
620
                        script.
574
621
                </para>
575
 
                <section>
 
622
                <section id="cfgutils.m.rand_set_prob">
576
623
                        <title><function moreinfo="none">rand_set_prop</function></title>
577
624
                        <para>
578
625
                                Set the probability value to the given parameter.
591
638
                        </example>
592
639
                        
593
640
                </section>
594
 
                <section>
 
641
                <section id="cfgutils.m.rand_reset_prob">
595
642
                        <title><function moreinfo="none">rand_reset_prob</function></title>
596
643
                        <para>
597
644
                                Reset the probability value to the inital start value.
609
656
</programlisting>
610
657
                        </example>
611
658
                </section>
612
 
                <section>
 
659
                <section  id="cfgutils.m.rand_get_prob">
613
660
                        <title><function moreinfo="none">rand_get_prob</function></title>
614
661
                        <para>
615
662
                                Return the actual probability setting.
627
674
</programlisting>
628
675
                        </example>
629
676
                </section>
630
 
                <section>
 
677
                <section id="cfgutils.m.check_config_hash">
631
678
                        <title><function moreinfo="none">check_config_hash</function></title>
632
679
                        <para>
633
680
                                Check if the actual config file hash is identical to the stored one.
647
694
</programlisting>
648
695
                        </example>
649
696
                </section>
650
 
                <section>
 
697
                <section id="cfgutils.m.get_config_hash">
651
698
                        <title><function moreinfo="none">get_config_hash</function></title>
652
699
                        <para>
653
700
                                Return the stored config file hash.
666
713
</programlisting>
667
714
                        </example>
668
715
                </section>
669
 
                                <section>
 
716
                <section  id="cfgutils.m.set_gflag">
670
717
                        <title><function moreinfo="none">set_gflag</function></title>
671
718
                        <para>
672
719
                        Set the value of some flags (specified by bitmask) to 1.
686
733
                        </example>
687
734
 
688
735
                </section>
689
 
                <section>
 
736
                <section  id="cfgutils.m.reset_gflag">
690
737
                        <title><function moreinfo="none">reset_gflag</function></title>
691
738
                        <para>
692
739
                        Reset the value of some flags to 0.
706
753
</programlisting>
707
754
                        </example>
708
755
                </section>
709
 
                <section>
 
756
                <section  id="cfgutils.m.is_gflag">
710
757
                        <title><function moreinfo="none">is_gflag</function></title>
711
758
                        <para>
712
759
                        Returns true if the all the flags from the bitmask are set.
741
788
</programlisting>
742
789
                        </example>
743
790
                </section>
744
 
                <section>
 
791
                <section id="cfgutils.m.get_gflags">
745
792
                        <title><function moreinfo="none">get_gflags</function></title>
746
793
                        <para>
747
794
                        Return the bitmap with all flags. The function gets no