[asterisk-commits] rmudgett: branch mmichelson/trunk-digiumphones r361519 - /team/mmichelson/tru...

[SVN commits to the Asterisk project]

Author: rmudgett
Date: Fri Apr  6 14:24:38 2012
New Revision: 361519

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=361519
Log:
Update Func MESSAGE() and AMI MessageSend documentation.

* Document MESSAGE(custom_data)

* Update AMI MessageSend documentation

* Eliminate a shadowed variable name in msg_func_write() for custom_data.

Modified:
    team/mmichelson/trunk-digiumphones/main/message.c

Modified: team/mmichelson/trunk-digiumphones/main/message.c
URL: http://svnview.digium.com/svn/asterisk/team/mmichelson/trunk-digiumphones/main/message.c?view=diff&rev=361519&r1=361518&r2=361519
==============================================================================
--- team/mmichelson/trunk-digiumphones/main/message.c (original)
+++ team/mmichelson/trunk-digiumphones/main/message.c Fri Apr  6 14:24:38 2012
@@ -56,6 +56,18 @@
 				<enum name="from">
 					<para>Read-only.  The source of the message.  When processing an
 					incoming message, this will be set to the source of the message.</para>
+				</enum>
+				<enum name="custom_data">
+					<para>Write-only.  Mark or unmark all message headers for an outgoing
+					message.  The following values can be set:</para>
+					<enumlist>
+						<enum name="mark_all_outbound">
+							<para>Mark all headers for an outgoing message.</para>
+						</enum>
+						<enum name="clear_all_outbound">
+							<para>Unmark all headers for an outgoing message.</para>
+						</enum>
+					</enumlist>
 				</enum>
 				<enum name="body">
 					<para>Read/Write.  The message body.  When processing an incoming
@@ -150,7 +162,12 @@
 				<para>The URI the message is to be sent to.</para>
 			</parameter>
 			<parameter name="From">
-				<para>The URI the message is from. Not required.</para>
+				<para>A From URI for the message if needed for the
+				message technology being used to send this message.</para>
+				<note>
+					<para>For SIP the from parameter can be a configured peer name
+					or in the form of "display-name" &lt;URI&gt;.</para>
+				</note>
 			</parameter>
 			<parameter name="Body">
 				<para>The message body text.  This must not contain any newlines as that
@@ -158,10 +175,13 @@
 			</parameter>
 			<parameter name="Base64Body">
 				<para>Text bodies requiring the use of newlines have to be base64 encoded
-				in this field.  The Base64Body will be decoded before being sent out.</para>
+				in this field.  Base64Body will be decoded before being sent out.
+				Base64Body takes precedence over Body.</para>
 			</parameter>
 			<parameter name="Variable">
-				<para>Message variable to set, multiple Variable: headers are allowed.</para>
+				<para>Message variable to set, multiple Variable: headers are
+				allowed.  The header value is a comma separated list of
+				name=value pairs.</para>
 			</parameter>
 		</syntax>
 	</manager>
@@ -890,12 +910,12 @@
 		}
 
 		if (outbound != -1) {
-			struct msg_data *data;
+			struct msg_data *hdr_data;
 			struct ao2_iterator iter = ao2_iterator_init(msg->vars, 0);
 
-			while ((data= ao2_iterator_next(&iter))) {
-				data->send = outbound;
-				ao2_ref(data, -1);
+			while ((hdr_data = ao2_iterator_next(&iter))) {
+				hdr_data->send = outbound;
+				ao2_ref(hdr_data, -1);
 			}
 			ao2_iterator_destroy(&iter);
 		}