[asterisk-commits] mmichelson: branch mmichelson/rls-config r416657 - /team/mmichelson/rls-confi...

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Wed Jun 18 17:00:13 2014
New Revision: 416657

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=416657
Log:
Add XML documentation for the forthcoming configuration stuff.


Modified:
    team/mmichelson/rls-config/res/res_pjsip_pubsub.c

Modified: team/mmichelson/rls-config/res/res_pjsip_pubsub.c
URL: http://svnview.digium.com/svn/asterisk/team/mmichelson/rls-config/res/res_pjsip_pubsub.c?view=diff&rev=416657&r1=416656&r2=416657
==============================================================================
--- team/mmichelson/rls-config/res/res_pjsip_pubsub.c (original)
+++ team/mmichelson/rls-config/res/res_pjsip_pubsub.c Wed Jun 18 17:00:13 2014
@@ -108,6 +108,66 @@
 					<synopsis>The time at which the subscription expires</synopsis>
 				</configOption>
 			</configObject>
+			<configObject name="resource_list">
+				<synopsis>Resource list configuration parameters.</synopsis>
+				<configOption name="type">
+					<synopsis>Must be of type 'resource_list'</synopsis>
+				</configOption>
+				<configOption name="event">
+					<synopsis>The SIP event package this list uses.</synopsis>
+					<description><para>
+						The SIP event package describes the types of resources that Asterisk reports
+						the state of.
+					</para>
+						<enumlist>
+							<enum name="presence"><para>
+								Device state and presence reporting.
+							</para></enum>
+							<enum name="message-summary"><para>
+								Message-waiting indication (MWI) reporting.
+							</para></enum>
+						</enumlist>
+					</description>
+				</configOption>
+				<configOption name="list_item">
+					<synopsis>The name of a resource to report state on</synopsis>
+					<description>
+						<para>In general Asterisk looks up list items in the following way:</para>
+						<para>1. Check if the list item refers to another configured resource list.
+						2. Pass the name of the resource off to event-package-specific handlers
+						   to find the specified resource.</para>
+						<para>The second part means that the way the list item is specified depends
+						on what type of list this is. For instance, if you have the <replaceable>event</replaceable>
+						set to <literal>presence</literal>, then list items should be in the form of
+						dialplan_extension at dialplan_context. For <literal>message-summary</literal> mailbox
+						names should be listed.</para>
+					</description>
+				</configOption>
+				<configOption name="full_state" default="no">
+					<synopsis>Indicates if the entire list's state should be sent out.</synopsis>
+					<description>
+						<para>If this option is enabled, and a resource changes state, then Asterisk will construct
+						a notification that contains the state of all resources in the list. If the option is
+						disabled, Asterisk will construct a notification that only contains the states of
+						resources that have changed.</para>
+						<note>
+							<para>Even with this option disabled, there are certain situations where Asterisk is forced
+							to send a notification with the states of all resources in the list. When a subscriber
+							renews or terminates its subscription to the list, Asterisk MUST send a full state
+							notification.</para>
+						</note>
+					</description>
+				</configOption>
+				<configOption name="notification_batch_interval" default="0">
+					<synopsis>Time Asterisk should wait, in milliseconds, between state changes and sending notifications.</synopsis>
+					<description>
+						<para>When a resource's state changes, it may be desired to wait a certain amount before Asterisk
+						sends a notification to subscribers. This allows for other state changes to accumulate, so that
+						Asterisk can communicate more state changes in a single notification instead of rapidly sending
+						many notifications.</para>
+					</description>
+				</configOption>
+			</configObject>
 		</configFile>
 	</configInfo>
  ***/