[asterisk-commits] mjordan: trunk r400122 - in /trunk: ./ configs/ res/

[SVN commits to the Asterisk project]

Author: mjordan
Date: Sat Sep 28 17:57:17 2013
New Revision: 400122

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=400122
Log:
res_pjsip_notify: Add documentation

We forgot to add documentation for res_pjsip_notify, which would prevent it
from being loaded. Whoops.

This patch also updates res_pjsip_notify to use pjsip_notify.conf, which now
has its own sample file in the configs directory as well.

Review: https://reviewboard.asterisk.org/r/2835/
........

Merged revisions 400121 from http://svn.asterisk.org/svn/asterisk/branches/12

Added:
    trunk/configs/pjsip_notify.conf.sample
      - copied unchanged from r400121, branches/12/configs/pjsip_notify.conf.sample
Modified:
    trunk/   (props changed)
    trunk/res/res_pjsip_notify.c

Propchange: trunk/
------------------------------------------------------------------------------
Binary property 'branch-12-merged' - no diff available.

Modified: trunk/res/res_pjsip_notify.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_pjsip_notify.c?view=diff&rev=400122&r1=400121&r2=400122
==============================================================================
--- trunk/res/res_pjsip_notify.c (original)
+++ trunk/res/res_pjsip_notify.c Sat Sep 28 17:57:17 2013
@@ -50,6 +50,46 @@
 			<para>Parameters will be placed into the notify as SIP headers.</para>
 		</description>
 	</manager>
+	<configInfo name="res_pjsip_notify" language="en_US">
+		<synopsis>Module that supports sending NOTIFY requests to endpoints from external sources</synopsis>
+		<configFile name="pjsip_notify.conf">
+			<configObject name="general">
+				<synopsis>Unused, but reserved.</synopsis>
+			</configObject>
+			<configObject name="notify">
+				<synopsis>Configuration of a NOTIFY request.</synopsis>
+				<description>
+					<para>Each key-value pair in a <literal>notify</literal>
+					configuration section defines either a SIP header to send
+					in the request or a line of content in the request message
+					body. A key of <literal>Content</literal> is treated
+					as part of the message body and is appended in sequential
+					order; any other header is treated as part of the SIP
+					request.</para>
+				</description>
+				<configOption name="^.*$">
+					<synopsis>A key/value pair to add to a NOTIFY request.</synopsis>
+					<description>
+						<para>If the key is <literal>Content</literal>,
+						it will be treated as part of the message body. Otherwise,
+						it will be added as a header in the NOTIFY request.</para>
+						<para>The following headers are reserved and cannot be
+						specified:</para>
+						<enumlist>
+							<enum name="Call-ID" />
+							<enum name="Contact" />
+							<enum name="CSeq" />
+							<enum name="To" />
+							<enum name="From" />
+							<enum name="Record-Route" />
+							<enum name="Route" />
+							<enum name="Via" />
+						</enumlist>
+					</description>
+				</configOption>
+			</configObject>
+		</configFile>
+	</configInfo>
  ***/
 
 #define CONTENT_TYPE_SIZE 64
@@ -59,7 +99,7 @@
  * \internal
  * \brief The configuration file containing NOTIFY payload types to send.
  */
-static const char notify_config[] = "sip_notify.conf";
+static const char notify_config[] = "pjsip_notify.conf";
 
 struct notify_option_item {
 	const char *name;