[asterisk-commits] file: branch file/pjsip-subscription-persistence r415335 - /team/file/pjsip-s...

[SVN commits to the Asterisk project]

Author: file
Date: Fri Jun  6 09:46:32 2014
New Revision: 415335

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=415335
Log:
Document the persistence object.

Modified:
    team/file/pjsip-subscription-persistence/res/res_pjsip_pubsub.c

Modified: team/file/pjsip-subscription-persistence/res/res_pjsip_pubsub.c
URL: http://svnview.digium.com/svn/asterisk/team/file/pjsip-subscription-persistence/res/res_pjsip_pubsub.c?view=diff&rev=415335&r1=415334&r2=415335
==============================================================================
--- team/file/pjsip-subscription-persistence/res/res_pjsip_pubsub.c (original)
+++ team/file/pjsip-subscription-persistence/res/res_pjsip_pubsub.c Fri Jun  6 09:46:32 2014
@@ -72,6 +72,44 @@
                         </para>
 		</description>
 	</manager>
+	<configInfo name="res_pjsip_pubsub" language="en_US">
+		<synopsis>Module that implements publish and subscribe support.</synopsis>
+		<configFile name="pjsip.conf">
+			<configObject name="subscription_persistence">
+				<synopsis>Persists SIP subscriptions so they survive restarts.</synopsis>
+				<configOption name="packet">
+					<synopsis>Entire SIP SUBSCRIBE packet that created the subscription</synopsis>
+				</configOption>
+				<configOption name="src_name">
+					<synopsis>The source address of the subscription</synopsis>
+				</configOption>
+				<configOption name="src_port">
+					<synopsis>The source port of the subscription</synopsis>
+				</configOption>
+				<configOption name="transport_key">
+					<synopsis>The type of transport the subscription was received on</synopsis>
+				</configOption>
+				<configOption name="local_name">
+					<synopsis>The local address the subscription was received on</synopsis>
+				</configOption>
+				<configOption name="local_port">
+					<synopsis>The local port the subscription was received on</synopsis>
+				</configOption>
+				<configOption name="cseq">
+					<synopsis>The sequence number of the next NOTIFY to be sent</synopsis>
+				</configOption>
+				<configOption name="tag">
+					<synopsis>The local tag of the dialog for the subscription</synopsis>
+				</configOption>
+				<configOption name="endpoint">
+					<synopsis>The name of the endpoint that subscribed</synopsis>
+				</configOption>
+				<configOption name="expires">
+					<synopsis>The time at which the subscription expires</synopsis>
+				</configOption>
+			</configObject>
+		</configFile>
+	</configInfo>
  ***/
 
 static pj_bool_t pubsub_on_rx_request(pjsip_rx_data *rdata);
@@ -1826,32 +1864,32 @@
 
 
 	ast_sorcery_apply_default(sorcery, "subscription_persistence", "astdb", "subscription_persistence");
-	if (ast_sorcery_internal_object_register(sorcery, "subscription_persistence", subscription_persistence_alloc,
+	if (ast_sorcery_object_register(sorcery, "subscription_persistence", subscription_persistence_alloc,
 		NULL, NULL)) {
 		ast_log(LOG_ERROR, "Could not register subscription persistence object support\n");
 		ast_sip_unregister_service(&pubsub_module);
 		ast_sched_context_destroy(sched);
 		return AST_MODULE_LOAD_FAILURE;	
 	}
-	ast_sorcery_object_field_register_nodoc(sorcery, "subscription_persistence", "packet", "", OPT_CHAR_ARRAY_T, 0,
+	ast_sorcery_object_field_register(sorcery, "subscription_persistence", "packet", "", OPT_CHAR_ARRAY_T, 0,
 		CHARFLDSET(struct subscription_persistence, packet));
-	ast_sorcery_object_field_register_nodoc(sorcery, "subscription_persistence", "src_name", "", OPT_CHAR_ARRAY_T, 0,
+	ast_sorcery_object_field_register(sorcery, "subscription_persistence", "src_name", "", OPT_CHAR_ARRAY_T, 0,
 		CHARFLDSET(struct subscription_persistence, src_name));
-	ast_sorcery_object_field_register_nodoc(sorcery, "subscription_persistence", "src_port", "0", OPT_UINT_T, 0,
+	ast_sorcery_object_field_register(sorcery, "subscription_persistence", "src_port", "0", OPT_UINT_T, 0,
 		FLDSET(struct subscription_persistence, src_port));
-	ast_sorcery_object_field_register_nodoc(sorcery, "subscription_persistence", "transport_key", "0", OPT_CHAR_ARRAY_T, 0,
+	ast_sorcery_object_field_register(sorcery, "subscription_persistence", "transport_key", "0", OPT_CHAR_ARRAY_T, 0,
 		CHARFLDSET(struct subscription_persistence, transport_key));
-	ast_sorcery_object_field_register_nodoc(sorcery, "subscription_persistence", "local_name", "", OPT_CHAR_ARRAY_T, 0,
+	ast_sorcery_object_field_register(sorcery, "subscription_persistence", "local_name", "", OPT_CHAR_ARRAY_T, 0,
 		CHARFLDSET(struct subscription_persistence, local_name));
-	ast_sorcery_object_field_register_nodoc(sorcery, "subscription_persistence", "local_port", "0", OPT_UINT_T, 0,
+	ast_sorcery_object_field_register(sorcery, "subscription_persistence", "local_port", "0", OPT_UINT_T, 0,
 		FLDSET(struct subscription_persistence, local_port));
-	ast_sorcery_object_field_register_nodoc(sorcery, "subscription_persistence", "cseq", "0", OPT_UINT_T, 0,
+	ast_sorcery_object_field_register(sorcery, "subscription_persistence", "cseq", "0", OPT_UINT_T, 0,
 		FLDSET(struct subscription_persistence, cseq));
-	ast_sorcery_object_field_register_custom_nodoc(sorcery, "subscription_persistence", "endpoint", "",
+	ast_sorcery_object_field_register_custom(sorcery, "subscription_persistence", "endpoint", "",
 		persistence_endpoint_str2struct, persistence_endpoint_struct2str, NULL, 0, 0);
-	ast_sorcery_object_field_register_custom_nodoc(sorcery, "subscription_persistence", "tag", "",
+	ast_sorcery_object_field_register_custom(sorcery, "subscription_persistence", "tag", "",
 		persistence_tag_str2struct, persistence_tag_struct2str, NULL, 0, 0);
-	ast_sorcery_object_field_register_custom_nodoc(sorcery, "subscription_persistence", "expires", "",
+	ast_sorcery_object_field_register_custom(sorcery, "subscription_persistence", "expires", "",
 		persistence_expires_str2struct, persistence_expires_struct2str, NULL, 0, 0);
 
 	ast_manager_register_xml(AMI_SHOW_SUBSCRIPTIONS_INBOUND, EVENT_FLAG_SYSTEM,