Browse code

uac Fixing formatting

Olle E. Johansson authored on 29/10/2012 18:50:48
Showing 2 changed files
... ...
@@ -44,23 +44,23 @@ Ramona-Elena Modroiu
44 44
               3.11. auth_password_avp (string)
45 45
               3.12. reg_db_url (string)
46 46
               3.13. reg_timer_interval (string)
47
+              3.14. reg_contact_addr (string)
47 48
 
48
-        4. reg_contact_addr (string)
49
-        5. Functions
49
+        4. Functions
50 50
 
51
-              5.1. uac_replace_from(display,uri)
52
-              5.2. uac_replace_from(uri)
53
-              5.3. uac_restore_from()
54
-              5.4. uac_replace_to(display,uri)
55
-              5.5. uac_replace_to(uri)
56
-              5.6. uac_restore_to()
57
-              5.7. uac_auth()
58
-              5.8. uac_req_send()
59
-              5.9. uac_reg_lookup(uuid, dst)
60
-              5.10. uac_reg_request_to(user, mode)
51
+              4.1. uac_replace_from(display,uri)
52
+              4.2. uac_replace_from(uri)
53
+              4.3. uac_restore_from()
54
+              4.4. uac_replace_to(display,uri)
55
+              4.5. uac_replace_to(uri)
56
+              4.6. uac_restore_to()
57
+              4.7. uac_auth()
58
+              4.8. uac_req_send()
59
+              4.9. uac_reg_lookup(uuid, dst)
60
+              4.10. uac_reg_request_to(user, mode)
61 61
 
62
-        6. Exported pseudo-variables
63
-        7. Remote Registration
62
+        5. Exported pseudo-variables
63
+        6. Remote Registration
64 64
 
65 65
    List of Examples
66 66
 
... ...
@@ -115,23 +115,23 @@ Chapter 1. Admin Guide
115 115
         3.11. auth_password_avp (string)
116 116
         3.12. reg_db_url (string)
117 117
         3.13. reg_timer_interval (string)
118
+        3.14. reg_contact_addr (string)
118 119
 
119
-   4. reg_contact_addr (string)
120
-   5. Functions
120
+   4. Functions
121 121
 
122
-        5.1. uac_replace_from(display,uri)
123
-        5.2. uac_replace_from(uri)
124
-        5.3. uac_restore_from()
125
-        5.4. uac_replace_to(display,uri)
126
-        5.5. uac_replace_to(uri)
127
-        5.6. uac_restore_to()
128
-        5.7. uac_auth()
129
-        5.8. uac_req_send()
130
-        5.9. uac_reg_lookup(uuid, dst)
131
-        5.10. uac_reg_request_to(user, mode)
122
+        4.1. uac_replace_from(display,uri)
123
+        4.2. uac_replace_from(uri)
124
+        4.3. uac_restore_from()
125
+        4.4. uac_replace_to(display,uri)
126
+        4.5. uac_replace_to(uri)
127
+        4.6. uac_restore_to()
128
+        4.7. uac_auth()
129
+        4.8. uac_req_send()
130
+        4.9. uac_reg_lookup(uuid, dst)
131
+        4.10. uac_reg_request_to(user, mode)
132 132
 
133
-   6. Exported pseudo-variables
134
-   7. Remote Registration
133
+   5. Exported pseudo-variables
134
+   6. Remote Registration
135 135
 
136 136
 1. Overview
137 137
 
... ...
@@ -189,6 +189,7 @@ Chapter 1. Admin Guide
189 189
    3.11. auth_password_avp (string)
190 190
    3.12. reg_db_url (string)
191 191
    3.13. reg_timer_interval (string)
192
+   3.14. reg_contact_addr (string)
192 193
 
193 194
 3.1. rr_from_store_param (string)
194 195
 
... ...
@@ -357,7 +358,7 @@ modparam("uac","auth_password_avp","$avp(i:12)")
357 358
    Example 1.12. Set reg_db_url parameter
358 359
 ...
359 360
 modparam("uac", "reg_db_url",
360
-    "mysql://openser:openserrw@localhost/openser")
361
+    "mysql://kamailio:kamailiorw@localhost/kamailio")
361 362
 ...
362 363
 
363 364
 3.13. reg_timer_interval (string)
... ...
@@ -372,7 +373,7 @@ modparam("uac", "reg_db_url",
372 373
 modparam("uac", "reg_timer_interval", 60)
373 374
 ...
374 375
 
375
-4. reg_contact_addr (string)
376
+3.14. reg_contact_addr (string)
376 377
 
377 378
    Address to be used to build contact address. Must be at least host
378 379
    part, can have port and parameters. Must not include 'sip:'.
... ...
@@ -382,20 +383,20 @@ modparam("uac", "reg_timer_interval", 60)
382 383
 modparam("uac", "reg_contact_addr", "192.168.1.2:5080")
383 384
 ...
384 385
 
385
-5. Functions
386
+4. Functions
386 387
 
387
-   5.1. uac_replace_from(display,uri)
388
-   5.2. uac_replace_from(uri)
389
-   5.3. uac_restore_from()
390
-   5.4. uac_replace_to(display,uri)
391
-   5.5. uac_replace_to(uri)
392
-   5.6. uac_restore_to()
393
-   5.7. uac_auth()
394
-   5.8. uac_req_send()
395
-   5.9. uac_reg_lookup(uuid, dst)
396
-   5.10. uac_reg_request_to(user, mode)
388
+   4.1. uac_replace_from(display,uri)
389
+   4.2. uac_replace_from(uri)
390
+   4.3. uac_restore_from()
391
+   4.4. uac_replace_to(display,uri)
392
+   4.5. uac_replace_to(uri)
393
+   4.6. uac_restore_to()
394
+   4.7. uac_auth()
395
+   4.8. uac_req_send()
396
+   4.9. uac_reg_lookup(uuid, dst)
397
+   4.10. uac_reg_request_to(user, mode)
397 398
 
398
-5.1. uac_replace_from(display,uri)
399
+4.1. uac_replace_from(display,uri)
399 400
 
400 401
    Replace in FROM header the display name and the URI part.
401 402
 
... ...
@@ -433,7 +434,7 @@ uac_replace_from("","sip:robin@gotham.org");
433 434
 uac_replace_from("","");
434 435
 ...
435 436
 
436
-5.2. uac_replace_from(uri)
437
+4.2. uac_replace_from(uri)
437 438
 
438 439
    Replace in FROM header the URI part without altering the display name.
439 440
 
... ...
@@ -446,7 +447,7 @@ uac_replace_from("","");
446 447
 uac_replace_from("sip:batman@gotham.org");
447 448
 ...
448 449
 
449
-5.3. uac_restore_from()
450
+4.3. uac_restore_from()
450 451
 
451 452
    This function will check if the FROM URI was modified and will use the
452 453
    information stored in header parameter to restore the original FROM URI
... ...
@@ -459,7 +460,7 @@ uac_replace_from("sip:batman@gotham.org");
459 460
 uac_restore_from();
460 461
 ...
461 462
 
462
-5.4. uac_replace_to(display,uri)
463
+4.4. uac_replace_to(display,uri)
463 464
 
464 465
    Replace in TO header the display name and the URI part.
465 466
 
... ...
@@ -479,7 +480,7 @@ uac_replace_to("","sip:robin@gotham.org");
479 480
 uac_replace_to("","");
480 481
 ...
481 482
 
482
-5.5. uac_replace_to(uri)
483
+4.5. uac_replace_to(uri)
483 484
 
484 485
    Replace in TO header the URI part without altering the display name.
485 486
 
... ...
@@ -510,7 +511,7 @@ uac_replace_to("","");
510 511
 uac_replace_to("sip:batman@gotham.org");
511 512
 ...
512 513
 
513
-5.6. uac_restore_to()
514
+4.6. uac_restore_to()
514 515
 
515 516
    This function will check if the TO URI was modified and will use the
516 517
    information stored in header parameter to restore the original TO URI
... ...
@@ -523,7 +524,7 @@ uac_replace_to("sip:batman@gotham.org");
523 524
 uac_restore_to();
524 525
 ...
525 526
 
526
-5.7. uac_auth()
527
+4.7. uac_auth()
527 528
 
528 529
    This function can be called only from failure route and will build the
529 530
    authentication response header and insert it into the request without
... ...
@@ -536,7 +537,7 @@ uac_restore_to();
536 537
 uac_auth();
537 538
 ...
538 539
 
539
-5.8. uac_req_send()
540
+4.8. uac_req_send()
540 541
 
541 542
    This function sends a SIP message from the configuration file. The
542 543
    message is built out of $uac_req(...) pseudo-variable.
... ...
@@ -553,7 +554,7 @@ $uac_req(turi)="sip:kamailio.org";
553 554
 uac_req_send();
554 555
 ...
555 556
 
556
-5.9. uac_reg_lookup(uuid, dst)
557
+4.9. uac_reg_lookup(uuid, dst)
557 558
 
558 559
    This function sets the PV dst to SIP URI that correspond to uuid in uac
559 560
    registations table. uuid and dst must be pseudo-variables.
... ...
@@ -569,7 +570,7 @@ if(uac_reg_lookup("$rU", "$ru"))
569 570
 }
570 571
 ...
571 572
 
572
-5.10. uac_reg_request_to(user, mode)
573
+4.10. uac_reg_request_to(user, mode)
573 574
 
574 575
    This function can be used to send an authenticated request to a remote
575 576
    user in the uac registrations table. It sets the request-uri, dst-uri
... ...
@@ -602,14 +603,14 @@ failure_route[REMOTE_AUTH] {
602 603
 }
603 604
 ...
604 605
 
605
-6. Exported pseudo-variables
606
+5. Exported pseudo-variables
606 607
 
607 608
      * $uac_req(key)
608 609
 
609 610
    Exported pseudo-variables are documented at
610 611
    http://www.kamailio.org/dokuwiki/.
611 612
 
612
-7. Remote Registration
613
+6. Remote Registration
613 614
 
614 615
    The module can register contact addresses to remote REGISTRAR servers.
615 616
    You have to add records to uacreg table. The table stores following
... ...
@@ -395,25 +395,25 @@ modparam("uac", "reg_timer_interval", 60)
395 395
 			</example>
396 396
 		</section>
397 397
 
398
-	</section>
399 398
 
400 399
 
401
-	<section id="reg-contact-addr-id">
402
-		<title><varname>reg_contact_addr</varname> (string)</title>
403
-		<para>
404
-		Address to be used to build contact address. Must be at least
405
-		host part, can have port and parameters. Must not include 'sip:'.
406
-		</para>
407
-		<example>
408
-			<title>Set <varname>reg_contact_addr</varname> parameter</title>
409
-			<programlisting format="linespecific">
400
+		<section id="reg-contact-addr-id">
401
+			<title><varname>reg_contact_addr</varname> (string)</title>
402
+			<para>
403
+			Address to be used to build contact address. Must be at least
404
+			host part, can have port and parameters. Must not include 'sip:'.
405
+			</para>
406
+			<example>
407
+				<title>Set <varname>reg_contact_addr</varname> parameter</title>
408
+				<programlisting format="linespecific">
410 409
 ...
411 410
 modparam("uac", "reg_contact_addr", "192.168.1.2:5080")
412 411
 ...
413
-			</programlisting>
414
-		</example>
415
-	</section>
412
+				</programlisting>
413
+			</example>
414
+		</section>
416 415
 
416
+	</section>
417 417
 
418 418
 	<section>
419 419
 		<title>Functions</title>