Browse code

usrloc: regenerated the readme

Daniel-Constantin Mierla authored on 28/08/2015 09:18:38
Showing 1 changed files
... ...
@@ -22,11 +22,11 @@ Carsten Bock
22 22
 
23 23
    ng-voice GmbH
24 24
 
25
-   Copyright © 2003 FhG FOKUS
25
+   Copyright � 2003 FhG FOKUS
26 26
 
27
-   Copyright © 2005 Voice Sistem SRL
27
+   Copyright � 2005 Voice Sistem SRL
28 28
 
29
-   Copyright © 2015 ng-voice GmbH
29
+   Copyright � 2015 ng-voice GmbH
30 30
      __________________________________________________________________
31 31
 
32 32
    Table of Contents
... ...
@@ -84,6 +84,7 @@ Carsten Bock
84 84
               3.38. expires_type (int)
85 85
               3.39. db_raw_fetch_type (int)
86 86
               3.40. db_insert_null (int)
87
+              3.41. skip_remote_socket (int)
87 88
 
88 89
         4. Functions
89 90
         5. MI Commands
... ...
@@ -181,6 +182,7 @@ Carsten Bock
181 182
    1.38. Set expires_type parameter
182 183
    1.39. Set db_raw_fetch_type parameter
183 184
    1.40. Set db_insert_null parameter
185
+   1.41. Set skip_remote_socket parameter
184 186
 
185 187
 Chapter 1. Admin Guide
186 188
 
... ...
@@ -237,6 +239,7 @@ Chapter 1. Admin Guide
237 239
         3.38. expires_type (int)
238 240
         3.39. db_raw_fetch_type (int)
239 241
         3.40. db_insert_null (int)
242
+        3.41. skip_remote_socket (int)
240 243
 
241 244
    4. Functions
242 245
    5. MI Commands
... ...
@@ -302,10 +305,12 @@ Chapter 1. Admin Guide
302 305
        contact and path must be matched as string; the cseq must be higher
303 306
        than the previous one - so be careful how you deal with REGISTER
304 307
        retransmissions in this case.
308
+     * Call-id only based - it is not according to RFC3261, as it will
309
+       check the Call-ID only (independent of the Contact-Header or Path).
305 310
 
306 311
    To find out how to control/select the contact maching algorithm, please
307
-   see the module parameter matching_mode - Section 3.26, “matching_mode
308
-   (integer)”.
312
+   see the module parameter matching_mode - Section 3.26, "matching_mode
313
+   (integer)".
309 314
 
310 315
 2. Dependencies
311 316
 
... ...
@@ -365,6 +370,7 @@ Chapter 1. Admin Guide
365 370
    3.38. expires_type (int)
366 371
    3.39. db_raw_fetch_type (int)
367 372
    3.40. db_insert_null (int)
373
+   3.41. skip_remote_socket (int)
368 374
 
369 375
 3.1. nat_bflag (integer)
370 376
 
... ...
@@ -372,7 +378,7 @@ Chapter 1. Admin Guide
372 378
    is or not natted). This is a branch flag and it will be imported and
373 379
    used by all other modules depending of usrloc module.
374 380
 
375
-   Default value is “not set”.
381
+   Default value is "not set".
376 382
 
377 383
    Example 1.1. Set nat_bflag parameter
378 384
 ...
... ...
@@ -383,7 +389,7 @@ modparam("usrloc", "nat_bflag", 3)
383 389
 
384 390
    Name of database column containing usernames.
385 391
 
386
-   Default value is “username”.
392
+   Default value is "username".
387 393
 
388 394
    Example 1.2. Set user_column parameter
389 395
 ...
... ...
@@ -394,7 +400,7 @@ modparam("usrloc", "user_column", "username")
394 400
 
395 401
    Name of database column containing domains.
396 402
 
397
-   Default value is “domain”.
403
+   Default value is "domain".
398 404
 
399 405
    Example 1.3. Set user_column parameter
400 406
 ...
... ...
@@ -405,7 +411,7 @@ modparam("usrloc", "domain_column", "domain")
405 411
 
406 412
    Name of database column containing contacts.
407 413
 
408
-   Default value is “contact”.
414
+   Default value is "contact".
409 415
 
410 416
    Example 1.4. Set contact_column parameter
411 417
 ...
... ...
@@ -416,7 +422,7 @@ modparam("usrloc", "contact_column", "contact")
416 422
 
417 423
    Name of database column containing expires value.
418 424
 
419
-   Default value is “expires”.
425
+   Default value is "expires".
420 426
 
421 427
    Example 1.5. Set expires_column parameter
422 428
 ...
... ...
@@ -427,7 +433,7 @@ modparam("usrloc", "expires_column", "expires")
427 433
 
428 434
    Name of database column containing q values.
429 435
 
430
-   Default value is “q”.
436
+   Default value is "q".
431 437
 
432 438
    Example 1.6. Set q_column parameter
433 439
 ...
... ...
@@ -438,7 +444,7 @@ modparam("usrloc", "q_column", "q")
438 444
 
439 445
    Name of database column containing Call-ID values.
440 446
 
441
-   Default value is “callid”.
447
+   Default value is "callid".
442 448
 
443 449
    Example 1.7. Set callid_column parameter
444 450
 ...
... ...
@@ -449,7 +455,7 @@ modparam("usrloc", "callid_column", "callid")
449 455
 
450 456
    Name of database column containing Cseq.
451 457
 
452
-   Default value is “cseq”.
458
+   Default value is "cseq".
453 459
 
454 460
    Example 1.8. Set cseq_column parameter
455 461
 ...
... ...
@@ -460,7 +466,7 @@ modparam("usrloc", "cseq_column", "cseq")
460 466
 
461 467
    Name of database column containing supported methods.
462 468
 
463
-   Default value is “methods”.
469
+   Default value is "methods".
464 470
 
465 471
    Example 1.9. Set methods_column parameter
466 472
 ...
... ...
@@ -471,7 +477,7 @@ modparam("usrloc", "methods_column", "methods")
471 477
 
472 478
    Name of database column to save the internal flags of the record.
473 479
 
474
-   Default value is “flags”.
480
+   Default value is "flags".
475 481
 
476 482
    Example 1.10. Set flags_column parameter
477 483
 ...
... ...
@@ -482,7 +488,7 @@ modparam("usrloc", "flags_column", "flags")
482 488
 
483 489
    Name of database column to save the branch/contact flags of the record.
484 490
 
485
-   Default value is “cflags”.
491
+   Default value is "cflags".
486 492
 
487 493
    Example 1.11. Set cflags_column parameter
488 494
 ...
... ...
@@ -493,7 +499,7 @@ modparam("usrloc", "cflags_column", "cflags")
493 499
 
494 500
    Name of database column containing user-agent values.
495 501
 
496
-   Default value is “user_agent”.
502
+   Default value is "user_agent".
497 503
 
498 504
    Example 1.12. Set user_agent_column parameter
499 505
 ...
... ...
@@ -505,7 +511,7 @@ modparam("usrloc", "user_agent_column", "user_agent")
505 511
    Name of database column containing the source IP, port, and protocol
506 512
    from the REGISTER message.
507 513
 
508
-   Default value is “received”.
514
+   Default value is "received".
509 515
 
510 516
    Example 1.13. Set received_column parameter
511 517
 ...
... ...
@@ -517,7 +523,7 @@ modparam("usrloc", "received_column", "received")
517 523
    Name of database column containing the received socket information
518 524
    (IP:port) for the REGISTER message.
519 525
 
520
-   Default value is “socket”.
526
+   Default value is "socket".
521 527
 
522 528
    Example 1.14. Set socket_column parameter
523 529
 ...
... ...
@@ -528,7 +534,7 @@ modparam("usrloc", "socket_column", "socket")
528 534
 
529 535
    Name of database column containing the Path header.
530 536
 
531
-   Default value is “path”.
537
+   Default value is "path".
532 538
 
533 539
    Example 1.15. Set path_column parameter
534 540
 ...
... ...
@@ -539,7 +545,7 @@ modparam("usrloc", "path_column", "path")
539 545
 
540 546
    Name of database column containing the Kamailio record unique id.
541 547
 
542
-   Default value is “ruid”.
548
+   Default value is "ruid".
543 549
 
544 550
    Example 1.16. Set ruid_column parameter
545 551
 ...
... ...
@@ -551,7 +557,7 @@ modparam("usrloc", "ruid_column", "myruid")
551 557
    Name of database column containing the SIP instance ID (GRUU -
552 558
    RFC5627). This is a unique device identifier - UUID.
553 559
 
554
-   Default value is “instance”.
560
+   Default value is "instance".
555 561
 
556 562
    Example 1.17. Set instance_column parameter
557 563
 ...
... ...
@@ -562,7 +568,7 @@ modparam("usrloc", "instance_column", "myinstance")
562 568
 
563 569
    Name of database table column containing the value for server id.
564 570
 
565
-   Default value is “server_id”.
571
+   Default value is "server_id".
566 572
 
567 573
    Example 1.18. Set server_id_column parameter
568 574
 ...
... ...
@@ -573,7 +579,7 @@ modparam("usrloc", "server_id_column", "srv_id")
573 579
 
574 580
    Name of database table column containing the value for connection id.
575 581
 
576
-   Default value is “connection_id”.
582
+   Default value is "connection_id".
577 583
 
578 584
    Example 1.19. Set connection_id_column parameter
579 585
 ...
... ...
@@ -585,7 +591,7 @@ modparam("usrloc", "connection_id_column", "con_id")
585 591
    Name of database table column containing the value for keepalive
586 592
    status.
587 593
 
588
-   Default value is “keepalive”.
594
+   Default value is "keepalive".
589 595
 
590 596
    Example 1.20. Set keepalive_column parameter
591 597
 ...
... ...
@@ -598,7 +604,7 @@ modparam("usrloc", "keepalive_column", "kalive")
598 604
    identifing the user (along with the username part). Useful in multi
599 605
    domain scenarios. Non 0 value means true.
600 606
 
601
-   Default value is “0 (false)”.
607
+   Default value is "0 (false)".
602 608
 
603 609
    Example 1.21. Set use_domain parameter
604 610
 ...
... ...
@@ -610,7 +616,7 @@ modparam("usrloc", "use_domain", 1)
610 616
    If the user's contacts should be kept timestamp ordered; otherwise the
611 617
    contact will be ordered based on q value. Non 0 value means true.
612 618
 
613
-   Default value is “0 (false)”.
619
+   Default value is "0 (false)".
614 620
 
615 621
    Example 1.22. Set desc_time_order parameter
616 622
 ...
... ...
@@ -634,7 +640,7 @@ modparam("usrloc", "timer_interval", 120)
634 640
 
635 641
    URL of the database that should be used.
636 642
 
637
-   Default value is “mysql://kamailio:kamailiorw@localhost/kamailio”.
643
+   Default value is "mysql://kamailio:kamailiorw@localhost/kamailio".
638 644
 
639 645
    Example 1.24. Set db_url parameter
640 646
 ...
... ...
@@ -695,7 +701,7 @@ modparam("usrloc", "db_mode", 2)
695 701
 3.26. matching_mode (integer)
696 702
 
697 703
    What contact matching algorithm to be used. Refer to section
698
-   Section 1.1, “Contact matching” for the description of the algorithms.
704
+   Section 1.1, "Contact matching" for the description of the algorithms.
699 705
 
700 706
    The parameter may take the following values:
701 707
      * 0 - CONTACT ONLY based matching algorithm.
... ...
@@ -703,6 +709,8 @@ modparam("usrloc", "db_mode", 2)
703 709
      * 2 - CONTACT and PATH based matching algorithm. This mode is like
704 710
        mode 0 but allows for duplicate contacts from differing paths. If
705 711
        no path is available, it defaults to mode 0.
712
+     * 3 - CALLID only based matching algorithm. This mode will discard
713
+       any duplicate registration coming through different paths.
706 714
 
707 715
    Default value is 0 (CONTACT_ONLY).
708 716
 
... ...
@@ -723,7 +731,7 @@ modparam("usrloc", "matching_mode", 1)
723 731
 
724 732
    A value of 0 disable the retransmission detection.
725 733
 
726
-   Default value is “20 seconds”.
734
+   Default value is "20 seconds".
727 735
 
728 736
    Example 1.27. Set cseq_delay parameter
729 737
 ...
... ...
@@ -737,7 +745,7 @@ modparam("usrloc", "cseq_delay", 5)
737 745
    startup. For 1MB of private memory (default) it should be below 4000.
738 746
    The database driver must support fetch_result() capability.
739 747
 
740
-   Default value is “2000”.
748
+   Default value is "2000".
741 749
 
742 750
    Example 1.28. Set fetch_rows parameter
743 751
 ...
... ...
@@ -750,7 +758,7 @@ modparam("usrloc", "fetch_rows", 3000)
750 758
    location records is 2^hash_size. For hash_size=4, the number of slots
751 759
    of the hash table is 16.
752 760
 
753
-   Default value is “10” (1024 slots).
761
+   Default value is "10" (1024 slots).
754 762
 
755 763
    Example 1.29. Set hash_size parameter
756 764
 ...
... ...
@@ -764,7 +772,7 @@ modparam("usrloc", "hash_size", 12)
764 772
    parameter only to load tables that are not used by registrar module
765 773
    directly in configuration file.
766 774
 
767
-   Default value is “NULL”.
775
+   Default value is "NULL".
768 776
 
769 777
    Example 1.30. Set preload parameter
770 778
 ...
... ...
@@ -777,7 +785,7 @@ modparam("usrloc", "preload", "location")
777 785
    UPDATE DB operations. It is recommended to set this parameter if you
778 786
    use Cassandra as a DB backend.
779 787
 
780
-   Default value is “0”.
788
+   Default value is "0".
781 789
 
782 790
    Example 1.31. Set db_update_as_insert parameter
783 791
 ...
... ...
@@ -792,7 +800,7 @@ modparam("usrloc", "db_update_as_insert", 1)
792 800
    parameter is ignored - e.g., MySQL and Postgres DB connectors offer
793 801
    affected_rows().
794 802
 
795
-   Default value is “0” (no DB INSERT).
803
+   Default value is "0" (no DB INSERT).
796 804
 
797 805
    Example 1.32. Set db_check_update parameter
798 806
 ...
... ...
@@ -806,7 +814,7 @@ modparam("usrloc", "db_check_update", 1)
806 814
    set to 0, no dedicated timer is started, the one from core will be
807 815
    used.
808 816
 
809
-   Default value is “0”.
817
+   Default value is "0".
810 818
 
811 819
    Example 1.33. Set timer_procs parameter
812 820
 ...
... ...
@@ -820,7 +828,7 @@ modparam("usrloc", "timer_procs", 4)
820 828
    xavp_contact must also be set to the same value to use the
821 829
    t_load_contacts and t_next_contacts functions.
822 830
 
823
-   Default value is “NULL”.
831
+   Default value is "NULL".
824 832
 
825 833
    Example 1.34. Set xavp_contact parameter
826 834
 ...
... ...
@@ -833,7 +841,7 @@ modparam("usrloc", "xavp_contact", "ulattrs")
833 841
    value. If it is set to 0, the old style using aor, contact and call-id
834 842
    is done.
835 843
 
836
-   Default value is “1”.
844
+   Default value is "1".
837 845
 
838 846
    Example 1.35. Set db_ops_ruid parameter
839 847
 ...
... ...
@@ -846,7 +854,7 @@ modparam("usrloc", "db_ops_ruid", 0)
846 854
    TCP/TLS/WS/WSS transports when it looses corresponding tcp connections.
847 855
    Does not currently work in DB-Only scheme.
848 856
 
849
-   Default value is “0”.
857
+   Default value is "0".
850 858
 
851 859
    Example 1.36. Set handle_lost_tcp parameter
852 860
 ...
... ...
@@ -858,7 +866,7 @@ modparam("usrloc", "handle_lost_tcp", 1)
858 866
    If set to 1, Kamailio will close the TCP connection when a contact has
859 867
    expired, if the corresponding transport is TCP/TLS/WS/WSS.
860 868
 
861
-   Default value is “0”.
869
+   Default value is "0".
862 870
 
863 871
    Example 1.37. Set close_expired_tcp parameter
864 872
 ...
... ...
@@ -873,7 +881,7 @@ modparam("usrloc", "close_expired_tcp", 1)
873 881
    expected to be on default type 'DATETIME'. When it is 1, the database
874 882
    columns types have to be changed manually to 'BIGINT'.
875 883
 
876
-   Default value is “0”.
884
+   Default value is "0".
877 885
 
878 886
    Example 1.38. Set expires_type parameter
879 887
 ...
... ...
@@ -888,7 +896,7 @@ modparam("usrloc", "expires_type", 1)
888 896
    (working for MySQL, PostgreSQL, ...). If it is set to 1, the query
889 897
    required by Oracle is used.
890 898
 
891
-   Default value is “0”.
899
+   Default value is "0".
892 900
 
893 901
    Example 1.39. Set db_raw_fetch_type parameter
894 902
 ...
... ...
@@ -900,13 +908,26 @@ modparam("usrloc", "db_raw_fetch_type", 1)
900 908
    If set to 1, the insert operation to database will add null values in
901 909
    the sql statement.
902 910
 
903
-   Default value is “0” (don't add null fields in insert statement).
911
+   Default value is "0" (don't add null fields in insert statement).
904 912
 
905 913
    Example 1.40. Set db_insert_null parameter
906 914
 ...
907 915
 modparam("usrloc", "db_insert_null", 1)
908 916
 ...
909 917
 
918
+3.41. skip_remote_socket (int)
919
+
920
+   If set to 1, Kamailio will skip location record when loading from
921
+   database, if socket value of the record does not in kamailio listening
922
+   socket list.
923
+
924
+   Default value is "0".
925
+
926
+   Example 1.41. Set skip_remote_socket parameter
927
+...
928
+modparam("usrloc", "skip_remote_socket", 1)
929
+...
930
+
910 931
 4. Functions
911 932
 
912 933
    There are no exported functions that could be used in scripts.
... ...
@@ -920,7 +941,7 @@ modparam("usrloc", "db_insert_null", 1)
920 941
    5.5. ul_add
921 942
    5.6. ul_show_contact
922 943
 
923
-5.1.  ul_rm
944
+5.1. ul_rm
924 945
 
925 946
    Deletes an entire AOR record (including its contacts).
926 947
 
... ...
@@ -929,7 +950,7 @@ modparam("usrloc", "db_insert_null", 1)
929 950
      * AOR - user AOR in username[@domain] format (domain must be supplied
930 951
        only if use_domain option is on).
931 952
 
932
-5.2.  ul_rm_contact
953
+5.2. ul_rm_contact
933 954
 
934 955
    Deletes a contact from an AOR record.
935 956
 
... ...
@@ -939,20 +960,20 @@ modparam("usrloc", "db_insert_null", 1)
939 960
        only if use_domain option is on).
940 961
      * contact - exact contact to be removed
941 962
 
942
-5.3.  ul_dump
963
+5.3. ul_dump
943 964
 
944 965
    Dumps the entire content of the USRLOC in memory cache
945 966
 
946 967
    Parameters:
947 968
      * brief - (optional, may not be present); if equals to string
948
-       “brief”, a brief dump will be done (only AOR and contacts, with no
969
+       "brief", a brief dump will be done (only AOR and contacts, with no
949 970
        other details)
950 971
 
951
-5.4.  ul_flush
972
+5.4. ul_flush
952 973
 
953 974
    Triggers the flush of USRLOC memory cache into DB.
954 975
 
955
-5.5.  ul_add
976
+5.5. ul_add
956 977
 
957 978
    Adds a new contact for an user AOR.
958 979
 
... ...
@@ -968,7 +989,7 @@ modparam("usrloc", "db_insert_null", 1)
968 989
      * cflags - per branch flags of the contact
969 990
      * methods - mask with supported requests of the contact
970 991
 
971
-5.6.  ul_show_contact
992
+5.6. ul_show_contact
972 993
 
973 994
    Dumps the contacts of an user AOR.
974 995
 
... ...
@@ -989,14 +1010,14 @@ modparam("usrloc", "db_insert_null", 1)
989 1010
    6.8. ul.db_contacts
990 1011
    6.9. ul.db_expired_contacts
991 1012
 
992
-6.1.  ul.dump
1013
+6.1. ul.dump
993 1014
 
994 1015
    Dumps the content of the location table
995 1016
 
996 1017
    Parameters:
997 1018
      * None.
998 1019
 
999
-6.2.  ul.lookup table AOR
1020
+6.2. ul.lookup table AOR
1000 1021
 
1001 1022
    Looks up the contents of an AOR entry in the location table
1002 1023
 
... ...
@@ -1005,7 +1026,7 @@ modparam("usrloc", "db_insert_null", 1)
1005 1026
      * AOR - user AOR in username[@domain] format (domain must be supplied
1006 1027
        only if use_domain option is on).
1007 1028
 
1008
-6.3.  ul.rm table AOR
1029
+6.3. ul.rm table AOR
1009 1030
 
1010 1031
    Deletes an entire AOR record (including its contacts).
1011 1032
 
... ...
@@ -1014,7 +1035,7 @@ modparam("usrloc", "db_insert_null", 1)
1014 1035
      * AOR - user AOR in username[@domain] format (domain must be supplied
1015 1036
        only if use_domain option is on).
1016 1037
 
1017
-6.4.  ul.rm_contact table AOR contact
1038
+6.4. ul.rm_contact table AOR contact
1018 1039
 
1019 1040
    Deletes a contact from an AOR record.
1020 1041
 
... ...
@@ -1024,11 +1045,11 @@ modparam("usrloc", "db_insert_null", 1)
1024 1045
        only if use_domain option is on).
1025 1046
      * contact - exact contact to be removed
1026 1047
 
1027
-6.5.  ul.flush
1048
+6.5. ul.flush
1028 1049
 
1029 1050
    Triggers the flush of USRLOC memory cache into DB.
1030 1051
 
1031
-6.6.  ul.add
1052
+6.6. ul.add
1032 1053
 
1033 1054
    Adds a new contact for an user AOR.
1034 1055
 
... ...
@@ -1044,7 +1065,7 @@ modparam("usrloc", "db_insert_null", 1)
1044 1065
      * cflags - per branch flags of the contact
1045 1066
      * methods - mask with supported requests of the contact
1046 1067
 
1047
-6.7.  ul.db_users
1068
+6.7. ul.db_users
1048 1069
 
1049 1070
    Tell number of different users (AoRs) in a location table that have
1050 1071
    unexpired contacts.
... ...
@@ -1053,7 +1074,7 @@ modparam("usrloc", "db_insert_null", 1)
1053 1074
      * table name - location table where the users are looked for, for
1054 1075
        example, location.
1055 1076
 
1056
-6.8.  ul.db_contacts
1077
+6.8. ul.db_contacts
1057 1078
 
1058 1079
    Tell number of unexpired contacts in a location table.
1059 1080
 
... ...
@@ -1061,7 +1082,7 @@ modparam("usrloc", "db_insert_null", 1)
1061 1082
      * table name - location table where the contacts are looked for, for
1062 1083
        example, location.
1063 1084
 
1064
-6.9.  ul.db_expired_contacts
1085
+6.9. ul.db_expired_contacts
1065 1086
 
1066 1087
    Tell number of expired contacts in a location table.
1067 1088
 
... ...
@@ -1150,7 +1171,7 @@ Chapter 2. Developer Guide
1150 1171
    1.15. ul_register_ulcb(type ,callback, param)
1151 1172
    1.16. ul_get_num_users()
1152 1173
 
1153
-1.1.  ul_register_domain(name)
1174
+1.1. ul_register_domain(name)
1154 1175
 
1155 1176
    The function registers a new domain. Domain is just another name for
1156 1177
    table used in registrar. The function is called from fixups in
... ...
@@ -1165,7 +1186,7 @@ Chapter 2. Developer Guide
1165 1186
      * const char* name - Name of the domain (also called table) to be
1166 1187
        registered.
1167 1188
 
1168
-1.2.  ul_insert_urecord(domain, aor, rec)
1189
+1.2. ul_insert_urecord(domain, aor, rec)
1169 1190
 
1170 1191
    The function creates a new record structure and inserts it in the
1171 1192
    specified domain. The record is structure that contains all the
... ...
@@ -1180,7 +1201,7 @@ Chapter 2. Developer Guide
1180 1201
 
1181 1202
      * urecord_t** rec - The newly created record structure.
1182 1203
 
1183
-1.3.  ul_delete_urecord(domain, aor)
1204
+1.3. ul_delete_urecord(domain, aor)
1184 1205
 
1185 1206
    The function deletes all the contacts bound with the given Address Of
1186 1207
    Record.
... ...
@@ -1192,7 +1213,7 @@ Chapter 2. Developer Guide
1192 1213
      * str* aor - Address of record (aka username) of the record, that
1193 1214
        should be deleted.
1194 1215
 
1195
-1.4.  ul_delete_urecord_by_ruid(domain, ruid)
1216
+1.4. ul_delete_urecord_by_ruid(domain, ruid)
1196 1217
 
1197 1218
    The function deletes from given domain a contact with given ruid.
1198 1219
 
... ...
@@ -1202,7 +1223,7 @@ Chapter 2. Developer Guide
1202 1223
 
1203 1224
      * str* ruid - ruid of contact that should be deleted.
1204 1225
 
1205
-1.5.  ul_get_urecord(domain, aor)
1226
+1.5. ul_get_urecord(domain, aor)
1206 1227
 
1207 1228
    The function returns pointer to record with given Address of Record.
1208 1229
 
... ...
@@ -1212,7 +1233,7 @@ Chapter 2. Developer Guide
1212 1233
 
1213 1234
      * str* aor - Address of Record of request record.
1214 1235
 
1215
-1.6.  ul_lock_udomain(domain)
1236
+1.6. ul_lock_udomain(domain)
1216 1237
 
1217 1238
    The function lock the specified domain, it means, that no other
1218 1239
    processes will be able to access during the time. This prevents race
... ...
@@ -1223,14 +1244,14 @@ Chapter 2. Developer Guide
1223 1244
    Meaning of the parameters is as follows:
1224 1245
      * udomain_t* domain - Domain to be locked.
1225 1246
 
1226
-1.7.  ul_unlock_udomain(domain)
1247
+1.7. ul_unlock_udomain(domain)
1227 1248
 
1228 1249
    Unlock the specified domain previously locked by ul_lock_udomain.
1229 1250
 
1230 1251
    Meaning of the parameters is as follows:
1231 1252
      * udomain_t* domain - Domain to be unlocked.
1232 1253
 
1233
-1.8.  ul_release_urecord(record)
1254
+1.8. ul_release_urecord(record)
1234 1255
 
1235 1256
    Do some sanity checks - if all contacts have been removed, delete the
1236 1257
    entire record structure.
... ...
@@ -1238,7 +1259,7 @@ Chapter 2. Developer Guide
1238 1259
    Meaning of the parameters is as follows:
1239 1260
      * urecord_t* record - Record to be released.
1240 1261
 
1241
-1.9.  ul_insert_ucontact(record, contact, expires, q, callid, cseq, flags,
1262
+1.9. ul_insert_ucontact(record, contact, expires, q, callid, cseq, flags,
1242 1263
 cont, ua, sock)
1243 1264
 
1244 1265
    The function inserts a new contact in the given record with specified
... ...
@@ -1259,7 +1280,7 @@ cont, ua, sock)
1259 1280
      * struct socket_info *sock - socket on which the REGISTER message was
1260 1281
        received on.
1261 1282
 
1262
-1.10.  ul_delete_ucontact (record, contact)
1283
+1.10. ul_delete_ucontact (record, contact)
1263 1284
 
1264 1285
    The function deletes given contact from record.
1265 1286
 
... ...
@@ -1269,7 +1290,7 @@ cont, ua, sock)
1269 1290
 
1270 1291
      * ucontact_t* contact - Contact to be deleted.
1271 1292
 
1272
-1.11.  ul_get_ucontact(record, contact)
1293
+1.11. ul_get_ucontact(record, contact)
1273 1294
 
1274 1295
    The function tries to find contact with given Contact URI and returns
1275 1296
    pointer to structure representing the contact.
... ...
@@ -1279,13 +1300,13 @@ cont, ua, sock)
1279 1300
 
1280 1301
      * str_t* contact - URI of the request contact.
1281 1302
 
1282
-1.12.  ul_get_all_ucontacts (buf, len, flags)
1303
+1.12. ul_get_all_ucontacts (buf, len, flags)
1283 1304
 
1284 1305
    The function retrieves all contacts of all registered users and returns
1285 1306
    them in the caller-supplied buffer. If the buffer is too small, the
1286 1307
    function returns positive value indicating how much additional space
1287 1308
    would be necessary to accommodate all of them. Please note that the
1288
-   positive return value should be used only as a “hint”, as there is no
1309
+   positive return value should be used only as a "hint", as there is no
1289 1310
    guarantee that during the time between two subsequent calls number of
1290 1311
    registered contacts will remain the same.
1291 1312
 
... ...
@@ -1300,7 +1321,7 @@ cont, ua, sock)
1300 1321
 
1301 1322
      * unsigned int flags - Flags that must be set.
1302 1323
 
1303
-1.13.  ul_update_ucontact(contact, expires, q, callid, cseq, set, res, ua,
1324
+1.13. ul_update_ucontact(contact, expires, q, callid, cseq, set, res, ua,
1304 1325
 sock)
1305 1326
 
1306 1327
    The function updates contact with new values.
... ...
@@ -1319,7 +1340,7 @@ sock)
1319 1340
      * struct socket_info *sock - socket on which the REGISTER message was
1320 1341
        received on.
1321 1342
 
1322
-1.14.  ul_bind_ursloc( api )
1343
+1.14. ul_bind_ursloc( api )
1323 1344
 
1324 1345
    The function imports all functions that are exported by the USRLOC
1325 1346
    module. Overs for other modules which want to user the internal USRLOC
... ...
@@ -1328,7 +1349,7 @@ sock)
1328 1349
    Meaning of the parameters is as follows:
1329 1350
      * usrloc_api_t* api - USRLOC API
1330 1351
 
1331
-1.15.  ul_register_ulcb(type ,callback, param)
1352
+1.15. ul_register_ulcb(type ,callback, param)
1332 1353
 
1333 1354
    The function register with USRLOC a callback function to be called when
1334 1355
    some event occures inside USRLOC.
... ...
@@ -1341,6 +1362,6 @@ sock)
1341 1362
      * void *param - some parameter to be passed to the callback each time
1342 1363
        when it is called.
1343 1364
 
1344
-1.16.  ul_get_num_users()
1365
+1.16. ul_get_num_users()
1345 1366
 
1346 1367
    The function loops through all domains summing up the number of users.