ソースを参照

presence: regenerated the readme

Daniel-Constantin Mierla 9 年 前
コミット
3e04a0ec8d
1 ファイル変更55 行追加39 行削除
  1. 55 39
      modules/presence/README

+ 55 - 39
modules/presence/README

@@ -57,10 +57,11 @@ Juha Heinanen
               3.24. fetch_rows (integer)
               3.24. fetch_rows (integer)
               3.25. db_table_lock_type (integer)
               3.25. db_table_lock_type (integer)
               3.26. local_log_level (int)
               3.26. local_log_level (int)
-              3.27. subs_remove_match (int)
-              3.28. xavp_cfg (str)
-              3.29. retrieve_order (int)
-              3.30. sip_uri_match (int)
+              3.27. local_log_facility (int)
+              3.28. subs_remove_match (int)
+              3.29. xavp_cfg (str)
+              3.30. retrieve_order (int)
+              3.31. sip_uri_match (int)
 
 
         4. Functions
         4. Functions
 
 
@@ -140,18 +141,19 @@ Juha Heinanen
    1.24. Set fetch_rows parameter
    1.24. Set fetch_rows parameter
    1.25. Set db_table_lock_type parameter
    1.25. Set db_table_lock_type parameter
    1.26. Set local_log_level parameter
    1.26. Set local_log_level parameter
-   1.27. Set subs_remove_match parameter
-   1.28. Set xavp_cfg parameter
-   1.29. Set retrieve_order parameter
-   1.30. Set sip_uri_match parameter
-   1.31. handle_publish usage
-   1.32. handle_subscribe usage
-   1.33. pres_auth_status usage
-   1.34. pres_refresh_watchers usage
-   1.35. pres_update_watchers usage
-   1.36. $subs(name) usage
-   1.37. $notify_reply(name) usage
+   1.27. Set local_log_facility parameter
+   1.28. Set subs_remove_match parameter
+   1.29. Set xavp_cfg parameter
+   1.30. Set retrieve_order parameter
+   1.31. Set sip_uri_match parameter
+   1.32. handle_publish usage
+   1.33. handle_subscribe usage
+   1.34. pres_auth_status usage
+   1.35. pres_refresh_watchers usage
+   1.36. pres_update_watchers usage
+   1.37. $subs(name) usage
    1.38. $notify_reply(name) usage
    1.38. $notify_reply(name) usage
+   1.39. $notify_reply(name) usage
    2.1. presence_api_t structure
    2.1. presence_api_t structure
 
 
 Chapter 1. Admin Guide
 Chapter 1. Admin Guide
@@ -192,10 +194,11 @@ Chapter 1. Admin Guide
         3.24. fetch_rows (integer)
         3.24. fetch_rows (integer)
         3.25. db_table_lock_type (integer)
         3.25. db_table_lock_type (integer)
         3.26. local_log_level (int)
         3.26. local_log_level (int)
-        3.27. subs_remove_match (int)
-        3.28. xavp_cfg (str)
-        3.29. retrieve_order (int)
-        3.30. sip_uri_match (int)
+        3.27. local_log_facility (int)
+        3.28. subs_remove_match (int)
+        3.29. xavp_cfg (str)
+        3.30. retrieve_order (int)
+        3.31. sip_uri_match (int)
 
 
    4. Functions
    4. Functions
 
 
@@ -296,10 +299,11 @@ Chapter 1. Admin Guide
    3.24. fetch_rows (integer)
    3.24. fetch_rows (integer)
    3.25. db_table_lock_type (integer)
    3.25. db_table_lock_type (integer)
    3.26. local_log_level (int)
    3.26. local_log_level (int)
-   3.27. subs_remove_match (int)
-   3.28. xavp_cfg (str)
-   3.29. retrieve_order (int)
-   3.30. sip_uri_match (int)
+   3.27. local_log_facility (int)
+   3.28. subs_remove_match (int)
+   3.29. xavp_cfg (str)
+   3.30. retrieve_order (int)
+   3.31. sip_uri_match (int)
 
 
 3.1. db_url(str)
 3.1. db_url(str)
 
 
@@ -693,7 +697,19 @@ modparam("presence", "db_table_lock_type", 0)
 modparam("presence", "local_log_level", 3)
 modparam("presence", "local_log_level", 3)
 ...
 ...
 
 
-3.27. subs_remove_match (int)
+3.27. local_log_facility (int)
+
+   Control syslog facility for some debug messages inside the module.
+
+   Default value is taken from the core log_facility configuration
+   parameter.
+
+   Example 1.27. Set local_log_facility parameter
+...
+modparam("presence", "local_log_facility", "LOG_LOCAL3")
+...
+
+3.28. subs_remove_match (int)
 
 
    Control how to match the subscriptions to remove from memory. If set to
    Control how to match the subscriptions to remove from memory. If set to
    0, then the match is done on To-Tag (local generated), if set to 1,
    0, then the match is done on To-Tag (local generated), if set to 1,
@@ -702,12 +718,12 @@ modparam("presence", "local_log_level", 3)
 
 
    Default value is 0.
    Default value is 0.
 
 
-   Example 1.27. Set subs_remove_match parameter
+   Example 1.28. Set subs_remove_match parameter
 ...
 ...
 modparam("presence", "subs_remove_match", 1)
 modparam("presence", "subs_remove_match", 1)
 ...
 ...
 
 
-3.28. xavp_cfg (str)
+3.29. xavp_cfg (str)
 
 
    The name of the xavp to be used to specify attributes for internal
    The name of the xavp to be used to specify attributes for internal
    processing of presence module.
    processing of presence module.
@@ -723,7 +739,7 @@ modparam("presence", "subs_remove_match", 1)
 
 
    Default value is empty (not set).
    Default value is empty (not set).
 
 
-   Example 1.28. Set xavp_cfg parameter
+   Example 1.29. Set xavp_cfg parameter
 ...
 ...
 modparam("presence", "xavp_cfg", "pres")
 modparam("presence", "xavp_cfg", "pres")
 ...
 ...
@@ -732,19 +748,19 @@ if(is_method("PUBLISH")) {
 }
 }
 ...
 ...
 
 
-3.29. retrieve_order (int)
+3.30. retrieve_order (int)
 
 
    If set to 0, presentity records are retrieve by received_time order. if
    If set to 0, presentity records are retrieve by received_time order. if
    set to 1, presentity records are retrieve by priority order.
    set to 1, presentity records are retrieve by priority order.
 
 
    Default value is 0.
    Default value is 0.
 
 
-   Example 1.29. Set retrieve_order parameter
+   Example 1.30. Set retrieve_order parameter
 ...
 ...
 modparam("presence", "retrieve_order", 1)
 modparam("presence", "retrieve_order", 1)
 ...
 ...
 
 
-3.30. sip_uri_match (int)
+3.31. sip_uri_match (int)
 
 
    The mode used when comparing uris.
    The mode used when comparing uris.
 
 
@@ -754,7 +770,7 @@ modparam("presence", "retrieve_order", 1)
 
 
    Default value is "0".
    Default value is "0".
 
 
-   Example 1.30. Set sip_uri_match parameter
+   Example 1.31. Set sip_uri_match parameter
             ...
             ...
             modparam("presence", "sip_uri_match", 1)
             modparam("presence", "sip_uri_match", 1)
             ...
             ...
@@ -787,7 +803,7 @@ modparam("presence", "retrieve_order", 1)
 
 
    The module sends an appropriate stateless reply in all cases.
    The module sends an appropriate stateless reply in all cases.
 
 
-   Example 1.31. handle_publish usage
+   Example 1.32. handle_publish usage
 ...
 ...
         if(is_method("PUBLISH"))
         if(is_method("PUBLISH"))
         {
         {
@@ -818,7 +834,7 @@ modparam("presence", "retrieve_order", 1)
 
 
    The module sends an appropriate stateless reply in all cases.
    The module sends an appropriate stateless reply in all cases.
 
 
-   Example 1.32. handle_subscribe usage
+   Example 1.33. handle_subscribe usage
 ...
 ...
 if(method=="SUBSCRIBE")
 if(method=="SUBSCRIBE")
     handle_subscribe();
     handle_subscribe();
@@ -835,7 +851,7 @@ if(method=="SUBSCRIBE")
 
 
    This function can be used from REQUEST_ROUTE.
    This function can be used from REQUEST_ROUTE.
 
 
-   Example 1.33. pres_auth_status usage
+   Example 1.34. pres_auth_status usage
 ...
 ...
 if (method=="MESSAGE") {
 if (method=="MESSAGE") {
     pres_auth_status("$fu", $ru");
     pres_auth_status("$fu", $ru");
@@ -871,7 +887,7 @@ if (method=="MESSAGE") {
 
 
    This function can be used from ANY_ROUTE.
    This function can be used from ANY_ROUTE.
 
 
-   Example 1.34. pres_refresh_watchers usage
+   Example 1.35. pres_refresh_watchers usage
 ...
 ...
 pres_refresh_watchers("sip:[email protected]", "presence", 1);
 pres_refresh_watchers("sip:[email protected]", "presence", 1);
 ...
 ...
@@ -889,7 +905,7 @@ pres_refresh_watchers("sip:[email protected]", "presence", 1);
 
 
    This function can be used from ANY_ROUTE.
    This function can be used from ANY_ROUTE.
 
 
-   Example 1.35. pres_update_watchers usage
+   Example 1.36. pres_update_watchers usage
 ...
 ...
 pres_update_watchers("sip:[email protected]", "presence");
 pres_update_watchers("sip:[email protected]", "presence");
 ...
 ...
@@ -995,7 +1011,7 @@ pres_update_watchers("sip:[email protected]", "presence");
      * flags
      * flags
      * user_agent
      * user_agent
 
 
-   Example 1.36. $subs(name) usage
+   Example 1.37. $subs(name) usage
 ...
 ...
 if(handle_subscription())
 if(handle_subscription())
 {
 {
@@ -1011,7 +1027,7 @@ if(handle_subscription())
 
 
    The "attr" can be any pseudo var that accesses attributes of msg
    The "attr" can be any pseudo var that accesses attributes of msg
 
 
-   Example 1.37. $notify_reply(name) usage
+   Example 1.38. $notify_reply(name) usage
 ...
 ...
 event_route[presence:notify-reply]
 event_route[presence:notify-reply]
 {
 {
@@ -1027,7 +1043,7 @@ event_route[presence:notify-reply]
 
 
    Fired after notify reply is received or timeout.
    Fired after notify reply is received or timeout.
 
 
-   Example 1.38. $notify_reply(name) usage
+   Example 1.39. $notify_reply(name) usage
 ...
 ...
 event_route[presence:notify-reply]
 event_route[presence:notify-reply]
 {
 {