[svn-commits] mmichelson: branch mmichelson/rls-notify r418166 - /team/mmichelson/rls-notif...

[SVN commits to the Digium repositories]

Author: mmichelson
Date: Mon Jul  7 19:30:05 2014
New Revision: 418166

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=418166
Log:
Add some documentation for the sip_subscription_tree and ast_sip_subscription structures.


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

Modified: team/mmichelson/rls-notify/res/res_pjsip_pubsub.c
URL: http://svnview.digium.com/svn/asterisk/team/mmichelson/rls-notify/res/res_pjsip_pubsub.c?view=diff&rev=418166&r1=418165&r2=418166
==============================================================================
--- team/mmichelson/rls-notify/res/res_pjsip_pubsub.c (original)
+++ team/mmichelson/rls-notify/res/res_pjsip_pubsub.c Mon Jul  7 19:30:05 2014
@@ -348,6 +348,15 @@
 	struct timeval expires;
 };
 
+/*!
+ * \brief A tree of SIP subscriptions
+ *
+ * Because of the ability to subscribe to resource lists, a SIP
+ * subscription can result in a tree of subscriptions being created.
+ * This structure represents the information relevant to the subscription
+ * as a whole, to include the underlying PJSIP structure for the
+ * subscription.
+ */
 struct sip_subscription_tree {
 	/*! The endpoint with which the subscription is communicating */
 	struct ast_sip_endpoint *endpoint;
@@ -376,7 +385,12 @@
 };
 
 /*!
- * \brief Structure representing a SIP subscription
+ * \brief Structure representing a "virtual" SIP subscription.
+ *
+ * This structure serves a dual purpose. Structurally, it is
+ * the constructed tree of subscriptions based on the resources
+ * being subscribed to. API-wise, this serves as the handle that
+ * subscription handlers use in order to interact with the pubsub API.
  */
 struct ast_sip_subscription {
 	/*! Subscription datastores set up by handlers */