Browse code

presence: readme rebuilt

Daniel-Constantin Mierla authored on 03/01/2015 10:51:09
Showing 1 changed files
... ...
@@ -56,6 +56,7 @@ Juha Heinanen
56 56
               3.21. fetch_rows (integer)
57 57
               3.22. db_table_lock_type (integer)
58 58
               3.23. local_log_level (int)
59
+              3.24. subs_remove_match (int)
59 60
 
60 61
         4. Functions
61 62
 
... ...
@@ -123,11 +124,12 @@ Juha Heinanen
123 124
    1.21. Set fetch_rows parameter
124 125
    1.22. Set db_table_lock_type parameter
125 126
    1.23. Set local_log_level parameter
126
-   1.24. handle_publish usage
127
-   1.25. handle_subscribe usage
128
-   1.26. pres_auth_status usage
129
-   1.27. pres_refresh_watchers usage
130
-   1.28. pres_update_watchers usage
127
+   1.24. Set subs_remove_match parameter
128
+   1.25. handle_publish usage
129
+   1.26. handle_subscribe usage
130
+   1.27. pres_auth_status usage
131
+   1.28. pres_refresh_watchers usage
132
+   1.29. pres_update_watchers usage
131 133
    2.1. presence_api_t structure
132 134
 
133 135
 Chapter 1. Admin Guide
... ...
@@ -165,6 +167,7 @@ Chapter 1. Admin Guide
165 167
         3.21. fetch_rows (integer)
166 168
         3.22. db_table_lock_type (integer)
167 169
         3.23. local_log_level (int)
170
+        3.24. subs_remove_match (int)
168 171
 
169 172
    4. Functions
170 173
 
... ...
@@ -253,6 +256,7 @@ Chapter 1. Admin Guide
253 256
    3.21. fetch_rows (integer)
254 257
    3.22. db_table_lock_type (integer)
255 258
    3.23. local_log_level (int)
259
+   3.24. subs_remove_match (int)
256 260
 
257 261
 3.1. db_url(str)
258 262
 
... ...
@@ -601,6 +605,20 @@ modparam("presence", "db_table_lock_type", 0)
601 605
 modparam("presence", "local_log_level", 3)
602 606
 ...
603 607
 
608
+3.24. subs_remove_match (int)
609
+
610
+   Control how to match the subscriptions to remove from memory. If set to
611
+   0, then the match is done on To-Tag (local generated), if set to 1,
612
+   then the match is done on all dialog attributes (Call-Id, From-Tag,
613
+   To-Tag).
614
+
615
+   Default value is 0.
616
+
617
+   Example 1.24. Set subs_remove_match parameter
618
+...
619
+modparam("presence", "subs_remove_match", 1)
620
+...
621
+
604 622
 4. Functions
605 623
 
606 624
    4.1. handle_publish(char* sender_uri)
... ...
@@ -629,7 +647,7 @@ modparam("presence", "local_log_level", 3)
629 647
 
630 648
    The module sends an appropriate stateless reply in all cases.
631 649
 
632
-   Example 1.24. handle_publish usage
650
+   Example 1.25. handle_publish usage
633 651
 ...
634 652
         if(is_method("PUBLISH"))
635 653
         {
... ...
@@ -660,7 +678,7 @@ modparam("presence", "local_log_level", 3)
660 678
 
661 679
    The module sends an appropriate stateless reply in all cases.
662 680
 
663
-   Example 1.25. handle_subscribe usage
681
+   Example 1.26. handle_subscribe usage
664 682
 ...
665 683
 if(method=="SUBSCRIBE")
666 684
     handle_subscribe();
... ...
@@ -677,7 +695,7 @@ if(method=="SUBSCRIBE")
677 695
 
678 696
    This function can be used from REQUEST_ROUTE.
679 697
 
680
-   Example 1.26. pres_auth_status usage
698
+   Example 1.27. pres_auth_status usage
681 699
 ...
682 700
 if (method=="MESSAGE") {
683 701
     pres_auth_status("$fu", $ru");
... ...
@@ -713,7 +731,7 @@ if (method=="MESSAGE") {
713 731
 
714 732
    This function can be used from ANY_ROUTE.
715 733
 
716
-   Example 1.27. pres_refresh_watchers usage
734
+   Example 1.28. pres_refresh_watchers usage
717 735
 ...
718 736
 pres_refresh_watchers("sip:test@kamailio.org", "presence", 1);
719 737
 ...
... ...
@@ -731,7 +749,7 @@ pres_refresh_watchers("sip:test@kamailio.org", "presence", 1);
731 749
 
732 750
    This function can be used from ANY_ROUTE.
733 751
 
734
-   Example 1.28. pres_update_watchers usage
752
+   Example 1.29. pres_update_watchers usage
735 753
 ...
736 754
 pres_update_watchers("sip:test@kamailio.org", "presence");
737 755
 ...