Browse code

sipcapture: docs for topoh_unmask parameter

Daniel-Constantin Mierla authored on 03/02/2016 21:52:11
Showing 2 changed files
... ...
@@ -10,9 +10,9 @@ Alexandr Dubovikov
10 10
 
11 11
    <alexandr.dubovikov@gmail.com>
12 12
 
13
-   Copyright © 2011 QSC AG
13
+   Copyright � 2011 QSC AG
14 14
 
15
-   Copyright © 2011 http://www.qsc.de
15
+   Copyright � 2011 http://www.qsc.de
16 16
      __________________________________________________________________
17 17
 
18 18
    Table of Contents
... ...
@@ -46,6 +46,7 @@ Alexandr Dubovikov
46 46
               3.17. insert_retries (integer)
47 47
               3.18. insert_retry_timeout (integer)
48 48
               3.19. callid_aleg_header (str)
49
+              3.20. topoh_unmask (int)
49 50
 
50 51
         4. Functions
51 52
 
... ...
@@ -84,8 +85,9 @@ Alexandr Dubovikov
84 85
    1.17. Set insert_retries parameter
85 86
    1.18. Set insert_retry_timeout parameter
86 87
    1.19. Set callid_aleg_header parameter
87
-   1.20. sip_capture() usage
88
+   1.20. Set topoh_unmask parameter
88 89
    1.21. sip_capture() usage
90
+   1.22. sip_capture() usage
89 91
 
90 92
 Chapter 1. Admin Guide
91 93
 
... ...
@@ -118,6 +120,7 @@ Chapter 1. Admin Guide
118 120
         3.17. insert_retries (integer)
119 121
         3.18. insert_retry_timeout (integer)
120 122
         3.19. callid_aleg_header (str)
123
+        3.20. topoh_unmask (int)
121 124
 
122 125
    4. Functions
123 126
 
... ...
@@ -188,6 +191,7 @@ Chapter 1. Admin Guide
188 191
    3.17. insert_retries (integer)
189 192
    3.18. insert_retry_timeout (integer)
190 193
    3.19. callid_aleg_header (str)
194
+   3.20. topoh_unmask (int)
191 195
 
192 196
 3.1. db_url (str)
193 197
 
... ...
@@ -445,12 +449,24 @@ modparam("sipcapture", "insert_retry_timeout", 10)
445 449
 modparam("sipcapture", "callid_aleg_header", "X-CallIDALeg")
446 450
 ...
447 451
 
452
+3.20. topoh_unmask (int)
453
+
454
+   If set to 1, call-id will be unmasked using topoh module api (topoh
455
+   module must be loaded in this case).
456
+
457
+   Default value is 0.
458
+
459
+   Example 1.20. Set topoh_unmask parameter
460
+...
461
+modparam("sipcapture", "topoh_unmask", 1)
462
+...
463
+
448 464
 4. Functions
449 465
 
450 466
    4.1. sip_capture([table])
451 467
    4.2. report_capture([table],[data])
452 468
 
453
-4.1.  sip_capture([table])
469
+4.1. sip_capture([table])
454 470
 
455 471
    Store the current processed HEP/IPIP SIP message in database. It is
456 472
    stored in the form prior applying changes made to it.
... ...
@@ -462,14 +478,14 @@ modparam("sipcapture", "callid_aleg_header", "X-CallIDALeg")
462 478
    ONREPLY_ROUTE, BRANCH_ROUTE.
463 479
    Default value is "NULL".
464 480
 
465
-   Example 1.20. sip_capture() usage
481
+   Example 1.21. sip_capture() usage
466 482
 ...
467 483
 sip_capture();
468 484
 ...
469 485
 sip_capture("sip_capture_call_20160124");
470 486
 ...
471 487
 
472
-4.2.  report_capture([table],[data])
488
+4.2. report_capture([table],[data])
473 489
 
474 490
    Store the current processed HEP REPORT message in database.
475 491
 
... ...
@@ -481,7 +497,7 @@ sip_capture("sip_capture_call_20160124");
481 497
    ONREPLY_ROUTE, BRANCH_ROUTE.
482 498
    Default value is "NULL".
483 499
 
484
-   Example 1.21. sip_capture() usage
500
+   Example 1.22. sip_capture() usage
485 501
 ...
486 502
 report_capture();
487 503
 ...
... ...
@@ -494,7 +510,7 @@ report_capture("report_data", "{\"MOS\":4.1,\"PACKET_LOST\":100"});
494 510
 
495 511
    5.1. sip_capture
496 512
 
497
-5.1.  sip_capture
513
+5.1. sip_capture
498 514
 
499 515
    Name: sip_capture
500 516
 
... ...
@@ -504,7 +520,7 @@ report_capture("report_data", "{\"MOS\":4.1,\"PACKET_LOST\":100"});
504 520
           + on
505 521
           + off
506 522
        The parameter is optional - if missing, the command will return the
507
-       status of the SIP message capturing (as string “on” or “off” )
523
+       status of the SIP message capturing (as string "on" or "off" )
508 524
        without changing anything.
509 525
 
510 526
    MI FIFO Command Format:
... ...
@@ -516,7 +532,7 @@ report_capture("report_data", "{\"MOS\":4.1,\"PACKET_LOST\":100"});
516 532
 
517 533
    6.1. sipcapture.status param
518 534
 
519
-6.1.  sipcapture.status param
535
+6.1. sipcapture.status param
520 536
 
521 537
    Name: sipcapture.status
522 538
 
... ...
@@ -524,7 +540,7 @@ report_capture("report_data", "{\"MOS\":4.1,\"PACKET_LOST\":100"});
524 540
      * on or off: turns on/off SIP message capturing. Possible values are:
525 541
           + on
526 542
           + off
527
-     * “check” does not change sipcapture status, just reports the current
543
+     * "check" does not change sipcapture status, just reports the current
528 544
        status.
529 545
 
530 546
 7. Database setup
... ...
@@ -471,6 +471,24 @@ modparam("sipcapture", "insert_retry_timeout", 10)
471 471
 			<programlisting format="linespecific">
472 472
 ...
473 473
 modparam("sipcapture", "callid_aleg_header", "X-CallIDALeg")
474
+...
475
+			</programlisting>
476
+		</example>
477
+	</section>
478
+	<section id="sipcapture.p.topoh_unmask">
479
+		<title><varname>topoh_unmask</varname> (int)</title>
480
+		<para>
481
+		If set to 1, call-id will be unmasked using topoh module api (topoh
482
+		module must be loaded in this case).
483
+		</para>
484
+		<para>
485
+			Default value is <emphasis>0</emphasis>.
486
+		</para>
487
+		<example>
488
+			<title>Set <varname>topoh_unmask</varname> parameter</title>
489
+			<programlisting format="linespecific">
490
+...
491
+modparam("sipcapture", "topoh_unmask", 1)
474 492
 ...
475 493
 			</programlisting>
476 494
 		</example>