[asterisk-commits] mmichelson: branch group/pimp_my_sip r380003 - /team/group/pimp_my_sip/includ...

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Wed Jan 23 10:33:02 2013
New Revision: 380003

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=380003
Log:
Add clarification comment for what is meant by "SIP session"

Thanks to Olle Johansson for bringing up our misuse of terminology
on the dev list. This should help SIP folks to better understand
what we mean when we say SIP session.


Modified:
    team/group/pimp_my_sip/include/asterisk/res_sip_session.h

Modified: team/group/pimp_my_sip/include/asterisk/res_sip_session.h
URL: http://svnview.digium.com/svn/asterisk/team/group/pimp_my_sip/include/asterisk/res_sip_session.h?view=diff&rev=380003&r1=380002&r2=380003
==============================================================================
--- team/group/pimp_my_sip/include/asterisk/res_sip_session.h (original)
+++ team/group/pimp_my_sip/include/asterisk/res_sip_session.h Wed Jan 23 10:33:02 2013
@@ -47,6 +47,11 @@
 
 /*!
  * \brief A structure describing a SIP session
+ *
+ * For the sake of brevity, a "SIP session" in Asterisk is referring to
+ * a dialog initiated by an INVITE. While "session" is typically interpreted
+ * to refer to the negotiated media within a SIP dialog, we have opted
+ * to use the term "SIP session" to refer to the INVITE dialog itself.
  */
 struct ast_sip_session {
 	/* Dialplan extension where incoming call is destined */