From a71aa0d3338a3e925053002d875d5f3ad969065c Mon Sep 17 00:00:00 2001 From: Victor Seva Date: Mon, 27 Jun 2016 13:39:24 +0200 Subject: [PATCH] sca: doc indent using tabs --- modules/sca/doc/sca_admin.xml | 546 +++++++++++++++++----------------- 1 file changed, 273 insertions(+), 273 deletions(-) diff --git a/modules/sca/doc/sca_admin.xml b/modules/sca/doc/sca_admin.xml index a3d84b176a3..fd200f5b87f 100644 --- a/modules/sca/doc/sca_admin.xml +++ b/modules/sca/doc/sca_admin.xml @@ -10,9 +10,9 @@ - &adminguide; + &adminguide; -
+
Overview The sca module implements Shared Call Appearances. It handles @@ -71,52 +71,52 @@ To date, this module has only been tested with Polycom Soundpoint 550s and 650s running Polycom SIP 3.3.4. -
+
-
+
Dependencies
- Modules - + Modules + The following modules must be loaded before this module: - - + + a database module - - - - + + + + sl - - - - + + + + tm - - + + - + +
-
-
+
Parameters
- <varname>hash_table_size</varname> (integer) - + <varname>hash_table_size</varname> (integer) + Size, as a power of two, of the shared memory hash table containing the call-info subscriptions and the appearance state. A larger power of two means better performance (fewer collisions, making for fewer subscriber URI comparisons) at the expense of increased shared memory use. - - + + - Default value is 9 (2 ^ 9 == 512). + Default value is 9 (2 ^ 9 == 512). - - + + Set <varname>hash_table_size</varname>: ... @@ -124,205 +124,205 @@ modparam( "sca", "hash_table_size", 8 ) ... - +
- <varname>call_info_max_expires</varname> (integer) - + <varname>call_info_max_expires</varname> (integer) + The maximum allowed call-info subscription time in seconds. - - + + - Default value is 3600 (1 hour). + Default value is 3600 (1 hour). - - + + Set <varname>call_info_max_expires</varname>: ... modparam( "sca", "call_info_max_expires", 1800 ) ... - +
-
- <varname>line_seize_max_expires</varname> (integer) - +
+ <varname>line_seize_max_expires</varname> (integer) + The maximum allowed line-seize subscription time in seconds. - - - - Default value is 15 (15 seconds). - - - + + + + Default value is 15 (15 seconds). + + + A maximum line-seize subscription time of 15 seconds is recommended in the SIP Access Side Extensions document. This interval is purposely short to prevent a client from seizing an appearance without making a call for extended periods of time. - - - Set <varname>line_seize_max_expires</varname>: - + + + Set <varname>line_seize_max_expires</varname>: + ... modparam( "sca", "line_seize_max_expires", 30 ) ... - - -
+ + +
-
- <varname>purge_expired_interval</varname> (integer) - +
+ <varname>purge_expired_interval</varname> (integer) + The period of time in seconds between purges of expired call-info and line-seize subscriptions. - - - - Default value is 120 (2 minutes). - - - + + + + Default value is 120 (2 minutes). + + + On finding an expired subscription, the module removes the subscription from the shared memory hash table, and sends a NOTIFY with Subscription-State "terminated;expired" header value to the subscriber. It also NOTIFYs other members of the group, in the event that the expired subscription was a line-seize. - - - Set <varname>purge_expired_interval</varname>: - + + + Set <varname>purge_expired_interval</varname>: + ... modparam( "sca", "purge_expired_interval", 60 ) ... - - -
+ + +
- <varname>db_url</varname> (str) - + <varname>db_url</varname> (str) + URL of database to which subscribers will be written. - - + + Default value is &defaultdb; - - + + Set <varname>db_url</varname> parameter: ... modparam( "sca", "db_url", "&defaultdb;" ) ... - +
-
- <varname>subs_table</varname> (str) - +
+ <varname>subs_table</varname> (str) + Name of the database table where call-info subscriptions are written. - - - - Default value is sca_subscriptions. - - - - Set <varname>subs_table</varname> parameter: - + + + + Default value is sca_subscriptions. + + + + Set <varname>subs_table</varname> parameter: + ... modparam( "sca", "subs_table", "call_info_subscriptions" ) ... - - -
+ + +
- <varname>db_update_interval</varname> (integer) - + <varname>db_update_interval</varname> (integer) + Period in seconds between writes of call-info subscriber information to the database. - - + + - Default value is 300 (5 minutes). + Default value is 300 (5 minutes). - - + + Set <varname>db_update_interval</varname>: ... modparam( "sca", "db_update_interval", 120 ) ... - + +
-
-
+
Functions
- + <title> <function moreinfo="none">sca_handle_subscribe()</function> - - + + The function handling call-info and line-seize SUBSCRIBE requests. It stores or updates the subscriptions in shared memory, and sends NOTIFYs to the subscriber and other members of the group as needed. - - + + For example, a line-seize SUBSCRIBE will cause the module to reserve an appearance index for the subscriber; send a line-seize NOTIFY to the subscriber indicating which appearance index it must use; and send call-info NOTIFYs to other subscribers to the address-of-record letting them know the appearance is off hook. - - + + This function can be used from the REQUEST_ROUTE. - - + + Return code: - - + + 1 - successful - - + + - - + + -1 - failed, error logged - - + + - - + + <function>sca_handle_subscribe</function> usage: ... if ( is_method( "SUBSCRIBE" )) { - if ( $hdr(Event) == "call-info" || $hdr(Event) == "line-seize" ) { + if ( $hdr(Event) == "call-info" || $hdr(Event) == "line-seize" ) { sca_handle_subscribe(); exit; - } + } } ... - +
-
- - <function moreinfo="none">sca_call_info_update()</function> - - +
+ + <function moreinfo="none">sca_call_info_update()</function> + + The sca_call_info_update function updates call state for SCA appearances. If a request or response packet contains a Call-Info header, the function extracts call state from @@ -333,238 +333,238 @@ if ( is_method( "SUBSCRIBE" )) { AoRs, the function looks up the appearance by dialog and updates call state as needed, sending NOTIFYs to members of the group if the call state has changed. - - + + The sca_call_info_update function updates call state for INVITE, CANCEL, BYE, PRACK and REFER requests and responses. - - - This function can be used from the REQUEST_ROUTE, REPLY_ROUTE, + + + This function can be used from the REQUEST_ROUTE, REPLY_ROUTE, and FAILURE_ROUTE. - - - Return code: - - - - 1 - successful - - + + + Return code: + + + + 1 - successful + + - - - -1 - failed, error logged - - - - - - <function>sca_call_info_update</function> usage: - + + + -1 - failed, error logged + + + + + + <function>sca_call_info_update</function> usage: + ... route { ... - sca_call_info_update(); + sca_call_info_update(); ... } onreply_route[REPLY_ROUTE] { ... - if ( status =~ "[456][0-9][0-9]" ) { + if ( status =~ "[456][0-9][0-9]" ) { # don't update SCA state here, since there may be # failure route processing (e.g., call forwarding). # update state in failure route instead. break; - } + } - sca_call_info_update(); + sca_call_info_update(); ... } failure_route[FAILURE_ROUTE] { ... - sca_call_info_update(); + sca_call_info_update(); ... } ... - - -
-
+ + +
+
-
+
Exported RPC Commands
- <varname>sca.all_subscriptions</varname> - + <varname>sca.all_subscriptions</varname> + List all current call-info and line-seize subscriptions. - - + + Name: sca.all_subscriptions - - + + Parameters: none - - + + Example: - - - &sercmd; sca.all_subscriptions - + + + &sercmd; sca.all_subscriptions +
- <varname>sca.all_appearances</varname> - + <varname>sca.all_appearances</varname> + List all SCA appearances with non-idle state. - - - Name: sca.all_appearances - - - Parameters: none - - - Example: - - - &sercmd; sca.all_appearances - -
+ + + Name: sca.all_appearances + + + Parameters: none + + + Example: + + + &sercmd; sca.all_appearances + +
-
- <varname>sca.seize_appearance</varname> - +
+ <varname>sca.seize_appearance</varname> + Seize an appearance index for a specific contact within an SCA group, and notify other members of the group that the appearance is off hook. Useful for testing SCA signaling. - - - Name: sca.seize_appearance - - - Parameters: 2 - - + + + Name: sca.seize_appearance + + + Parameters: 2 + + - SCA Address-of-Record + SCA Address-of-Record - SCA Contact URI + SCA Contact URI - - - Example: - - - # seize next available appearance of sip:215@voice.example.com - # for contact sip:215@10.0.1.2 - &sercmd; sca.seize_appearance sip:215@voice.example.com sip:215@10.0.1.2 - -
+ + + Example: + + + # seize next available appearance of sip:215@voice.example.com + # for contact sip:215@10.0.1.2 + &sercmd; sca.seize_appearance sip:215@voice.example.com sip:215@10.0.1.2 + +
-
- <varname>sca.update_appearance</varname> - +
+ <varname>sca.update_appearance</varname> + Update the state of an in-use appearance index, and notify other members of the group. Useful for testing SCA signaling. - - - Name: sca.update_appearance - - - Parameters: 3 or 4 - - + + + Name: sca.update_appearance + + + Parameters: 3 or 4 + + - SCA Address-of-Record + SCA Address-of-Record - Index of In-Use Appearance + Index of In-Use Appearance - Appearance State - (seized, ringing, progressing, active, held, held-private) + Appearance State + (seized, ringing, progressing, active, held, held-private) - Appearance Display Info (Optional) + Appearance Display Info (Optional) - - - Example: - - - # update in-use appearance index 3 of sip:215@voice.example.com - # state held. - &sercmd; sca.update_appearance sip:215@voice.example.com 3 held - -
+ + + Example: + + + # update in-use appearance index 3 of sip:215@voice.example.com + # state held. + &sercmd; sca.update_appearance sip:215@voice.example.com 3 held + +
-
- <varname>sca.release_appearance</varname> - +
+ <varname>sca.release_appearance</varname> + Set a non-idle appearance index to idle and NOTIFY members of the group. - - - Name: sca.release_appearance - - - Parameters: 2 - - + + + Name: sca.release_appearance + + + Parameters: 2 + + - SCA Address-of-Record + SCA Address-of-Record - Appearance Index + Appearance Index - - - Example: - - - # release appearance of sip:215@voice.example.com with - # appearance index 3 - &sercmd; sca.release_appearance sip:215@voice.example.com 3 - -
-
+ + + Example: + + + # release appearance of sip:215@voice.example.com with + # appearance index 3 + &sercmd; sca.release_appearance sip:215@voice.example.com 3 + +
+ -
+
Sample &kamailioconfig; with SCA - The following is a basic &kamailioconfig; providing Shared Call - Appearances to local subscribers. It has been tested with - Polycom handsets. + The following is a basic &kamailioconfig; providing Shared Call + Appearances to local subscribers. It has been tested with + Polycom handsets. - &kamailioconfig; - + &kamailioconfig; + ## - + -
+