[asterisk-commits] qwell: branch qwell/agi_events r390376 - /team/qwell/agi_events/res/res_agi.c

SVN commits to the Asterisk project asterisk-commits at lists.digium.com
Mon Jun 3 11:44:31 CDT 2013


Author: qwell
Date: Mon Jun  3 11:44:28 2013
New Revision: 390376

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=390376
Log:
First, fix docs.

Modified:
    team/qwell/agi_events/res/res_agi.c

Modified: team/qwell/agi_events/res/res_agi.c
URL: http://svnview.digium.com/svn/asterisk/team/qwell/agi_events/res/res_agi.c?view=diff&rev=390376&r1=390375&r2=390376
==============================================================================
--- team/qwell/agi_events/res/res_agi.c (original)
+++ team/qwell/agi_events/res/res_agi.c Mon Jun  3 11:44:28 2013
@@ -928,6 +928,62 @@
 			<para>Add an AGI command to the execute queue of the channel in Async AGI.</para>
 		</description>
 	</manager>
+	<managerEvent language="en_US" name="AsyncAGIStart">
+		<managerEventInstance class="EVENT_FLAG_AGI">
+			<synopsis>Raised when a channel starts AsyncAGI command processing.</synopsis>
+			<syntax>
+				<parameter name="Env">
+					<para>URL encoded string read from the AsyncAGI server.</para>
+				</parameter>
+			</syntax>
+		</managerEventInstance>
+	</managerEvent>
+	<managerEvent language="en_US" name="AsyncAGIEnd">
+		<managerEventInstance class="EVENT_FLAG_AGI">
+			<synopsis>Raised when a channel stops AsyncAGI command processing.</synopsis>
+		</managerEventInstance>
+	</managerEvent>
+	<managerEvent language="en_US" name="AsyncAGIExec">
+		<managerEventInstance class="EVENT_FLAG_AGI">
+			<synopsis>Raised when AsyncAGI completes an AGI command.</synopsis>
+			<syntax>
+				<parameter name="CommandID" required="false">
+					<para>Optional command ID sent by the AsyncAGI server to identify the command.</para>
+				</parameter>
+				<parameter name="Result">
+					<para>URL encoded result string from the executed AGI command.</para>
+				</parameter>
+			</syntax>
+		</managerEventInstance>
+	</managerEvent>
+	<managerEvent language="en_US" name="AGIExecStart">
+		<managerEventInstance class="EVENT_FLAG_AGI">
+			<synopsis>Raised when a received AGI command starts processing.</synopsis>
+			<syntax>
+				<parameter name="Command">
+					<para>The AGI command as received from the external source.</para>
+				</parameter>
+				<parameter name="CommandId">
+					<para>Random identification number assigned to the execution of this command.</para>
+				</parameter>
+			</syntax>
+		</managerEventInstance>
+	</managerEvent>
+	<managerEvent language="en_US" name="AGIExecEnd">
+		<managerEventInstance class="EVENT_FLAG_AGI">
+			<synopsis>Raised when a received AGI command completes processing.</synopsis>
+			<syntax>
+				<xi:include xpointer="xpointer(/docs/managerEvent[@name='AGIExecStart']/managerEventInstance/syntax/parameter[@name='Command'])" />
+				<xi:include xpointer="xpointer(/docs/managerEvent[@name='AGIExecStart']/managerEventInstance/syntax/parameter[@name='CommandId'])" />
+				<parameter name="ResultCode">
+					<para>The numeric result code from AGI</para>
+				</parameter
+				<parameter name="Result">
+					<para>The text result reason from AGI</para>
+				</parameter
+			</syntax>
+		</managerEventInstance>
+	</managerEvent>
  ***/
 
 #define MAX_ARGS 128
@@ -1349,24 +1405,6 @@
 	   care of AGI commands on this channel can decide which AGI commands
 	   to execute based on the setup info */
 	ast_uri_encode(agi_buffer, ami_buffer, AMI_BUF_SIZE, ast_uri_http);
-	/*** DOCUMENTATION
-		<managerEventInstance>
-			<synopsis>Raised when a channel starts AsyncAGI command processing.</synopsis>
-			<syntax>
-				<parameter name="SubEvent">
-					<para>A sub event type, specifying the channel AsyncAGI processing status.</para>
-					<enumlist>
-						<enum name="Start"/>
-						<enum name="Exec"/>
-						<enum name="End"/>
-					</enumlist>
-				</parameter>
-				<parameter name="Env">
-					<para>URL encoded string read from the AsyncAGI server.</para>
-				</parameter>
-			</syntax>
-		</managerEventInstance>
-	***/
 	manager_event(EVENT_FLAG_AGI, "AsyncAGI",
 		"SubEvent: Start\r\n"
 		"Channel: %s\r\n"
@@ -1423,19 +1461,6 @@
 					ast_channel_uniqueid(chan),
 					ami_buffer);
 			} else {
-				/*** DOCUMENTATION
-					<managerEventInstance>
-						<synopsis>Raised when AsyncAGI completes an AGI command.</synopsis>
-						<syntax>
-							<parameter name="CommandID" required="false">
-								<para>Optional command ID sent by the AsyncAGI server to identify the command.</para>
-							</parameter>
-							<parameter name="Result">
-								<para>URL encoded result string from the executed AGI command.</para>
-							</parameter>
-						</syntax>
-					</managerEventInstance>
-				***/
 				manager_event(EVENT_FLAG_AGI, "AsyncAGI",
 					"SubEvent: Exec\r\n"
 					"Channel: %s\r\n"
@@ -1505,11 +1530,6 @@
 		ast_speech_destroy(async_agi.speech);
 	}
 	/* notify manager users this channel cannot be controlled anymore by Async AGI */
-	/*** DOCUMENTATION
-		<managerEventInstance>
-			<synopsis>Raised when a channel stops AsyncAGI command processing.</synopsis>
-		</managerEventInstance>
-	***/
 	manager_event(EVENT_FLAG_AGI, "AsyncAGI",
 		"SubEvent: End\r\n"
 		"Channel: %s\r\n"
@@ -3557,26 +3577,6 @@
 	int command_id = ast_random();
 	int resultcode;
 
-	/*** DOCUMENTATION
-		<managerEventInstance>
-			<synopsis>Raised when a received AGI command starts processing.</synopsis>
-			<syntax>
-				<parameter name="SubEvent">
-					<para>A sub event type, specifying whether the AGI command has begun or ended.</para>
-					<enumlist>
-						<enum name="Start"/>
-						<enum name="End"/>
-					</enumlist>
-				</parameter>
-				<parameter name="CommandId">
-					<para>Random identification number assigned to the execution of this command.</para>
-				</parameter>
-				<parameter name="Command">
-					<para>The AGI command as received from the external source.</para>
-				</parameter>
-			</syntax>
-		</managerEventInstance>
-	***/
 	manager_event(EVENT_FLAG_AGI, "AGIExec",
 		"SubEvent: Start\r\n"
 		"Channel: %s\r\n"
@@ -3621,11 +3621,6 @@
 			resultcode = 200;
 			break;
 		}
-		/*** DOCUMENTATION
-			<managerEventInstance>
-				<synopsis>Raised when a received AGI command completes processing.</synopsis>
-			</managerEventInstance>
-		***/
 		manager_event(EVENT_FLAG_AGI, "AGIExec",
 			"SubEvent: End\r\n"
 			"Channel: %s\r\n"




More information about the asterisk-commits mailing list