diff options
| author | Matthew Jordan <mjordan@digium.com> | 2013-09-28 22:57:17 +0000 |
|---|---|---|
| committer | Matthew Jordan <mjordan@digium.com> | 2013-09-28 22:57:17 +0000 |
| commit | a1d56da32a98d1c5001dde9fc710b38e10781eb2 (patch) | |
| tree | ebf1df02081477b6e3e694738036879a557b6c80 /res/res_pjsip_notify.c | |
| parent | c4b5c549fd0afb5b9657e64ff0e9beb0fa79a74d (diff) | |
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
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@400122 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'res/res_pjsip_notify.c')
| -rw-r--r-- | res/res_pjsip_notify.c | 42 |
1 files changed, 41 insertions, 1 deletions
diff --git a/res/res_pjsip_notify.c b/res/res_pjsip_notify.c index c90a91b15..8e9b20261 100644 --- a/res/res_pjsip_notify.c +++ b/res/res_pjsip_notify.c @@ -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; |