res_pjsip_notify: Add documentation
authorMatthew Jordan <mjordan@digium.com>
Sat, 28 Sep 2013 22:57:17 +0000 (22:57 +0000)
committerMatthew Jordan <mjordan@digium.com>
Sat, 28 Sep 2013 22:57:17 +0000 (22:57 +0000)
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

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@400122 65c4cc65-6c06-0410-ace0-fbb531ad65f3

configs/pjsip_notify.conf.sample [new file with mode: 0644]
res/res_pjsip_notify.c

diff --git a/configs/pjsip_notify.conf.sample b/configs/pjsip_notify.conf.sample
new file mode 100644 (file)
index 0000000..8224ee1
--- /dev/null
@@ -0,0 +1,57 @@
+; rfc3842
+; put empty "Content=>" at the end to have CRLF after last body line
+
+[clear-mwi]
+Event=>message-summary
+Content-type=>application/simple-message-summary
+Content=>Messages-Waiting: no
+Content=>Message-Account: sip:asterisk@127.0.0.1
+Content=>Voice-Message: 0/0 (0/0)
+Content=>
+
+; Aastra
+
+[aastra-check-cfg]
+Event=>check-sync
+
+[aastra-xml]
+Event=>aastra-xml
+
+; Digium
+
+[digium-check-cfg]
+Event=>check-sync
+
+; Linksys
+
+[linksys-cold-restart]
+Event=>reboot_now
+
+[linksys-warm-restart]
+Event=>restart_now
+
+; Polycom
+
+[polycom-check-cfg]
+Event=>check-sync
+
+; Sipura
+
+[sipura-check-cfg]
+Event=>resync
+
+[sipura-get-report]
+Event=>report
+
+; snom
+
+[snom-check-cfg]
+Event=>check-sync\;reboot=false
+
+[snom-reboot]
+Event=>check-sync\;reboot=true
+
+; Cisco
+
+[cisco-check-cfg]
+Event=>check-sync
index c90a91b..8e9b202 100644 (file)
                        <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;