[asterisk-commits] mjordan: branch mjordan/manager-events r368662 - in /team/mjordan/manager-eve...
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Wed Jun 6 17:41:55 CDT 2012
Author: mjordan
Date: Wed Jun 6 17:41:51 2012
New Revision: 368662
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=368662
Log:
Final commit before initial review
Modified:
team/mjordan/manager-events/apps/app_confbridge.c
team/mjordan/manager-events/apps/app_meetme.c
team/mjordan/manager-events/apps/app_queue.c
team/mjordan/manager-events/apps/app_stack.c
team/mjordan/manager-events/apps/app_userevent.c
team/mjordan/manager-events/build_tools/get_documentation.py
team/mjordan/manager-events/build_tools/make_version
team/mjordan/manager-events/main/xmldoc.c
Modified: team/mjordan/manager-events/apps/app_confbridge.c
URL: http://svnview.digium.com/svn/asterisk/team/mjordan/manager-events/apps/app_confbridge.c?view=diff&rev=368662&r1=368661&r2=368662
==============================================================================
--- team/mjordan/manager-events/apps/app_confbridge.c (original)
+++ team/mjordan/manager-events/apps/app_confbridge.c Wed Jun 6 17:41:51 2012
@@ -555,6 +555,7 @@
</syntax>
<see-also>
<ref type="managerEvent">ConfbridgeStart</ref>
+ <ref type="application">ConfBridge</ref>
</see-also>
</managerEventInstance>
***/
@@ -566,11 +567,12 @@
/*** DOCUMENTATION
<managerEventInstance>
<synopsis>Raised when a channel joins a Confbridge conference.</synopsis>
- <parameter name="Conference">
- <para>The name of the Confbridge conference.</para>
- </parameter>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='ConfbridgeStart']/managerEventInstance/syntax/parameter[@name='Conference'])" />
+ </syntax>
<see-also>
<ref type="managerEvent">ConfbridgeLeave</ref>
+ <ref type="application">ConfBridge</ref>
</see-also>
</managerEventInstance>
***/
@@ -593,9 +595,9 @@
/*** DOCUMENTATION
<managerEventInstance>
<synopsis>Raised when a channel leaves a Confbridge conference.</synopsis>
- <parameter name="Conference">
- <para>The name of the Confbridge conference.</para>
- </parameter>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='ConfbridgeStart']/managerEventInstance/syntax/parameter[@name='Conference'])" />
+ </syntax>
<see-also>
<ref type="managerEvent">ConfbridgeJoin</ref>
</see-also>
@@ -1292,9 +1294,7 @@
<managerEventInstance>
<synopsis>Raised when a conference participant has started or stopped talking.</synopsis>
<syntax>
- <parameter name="Conference">
- <para>The name of the Confbridge conference.</para>
- </parameter>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='ConfbridgeStart']/managerEventInstance/syntax/parameter[@name='Conference'])" />
<parameter name="TalkingStatus">
<enumlist>
<enum name="on"/>
Modified: team/mjordan/manager-events/apps/app_meetme.c
URL: http://svnview.digium.com/svn/asterisk/team/mjordan/manager-events/apps/app_meetme.c?view=diff&rev=368662&r1=368661&r2=368662
==============================================================================
--- team/mjordan/manager-events/apps/app_meetme.c (original)
+++ team/mjordan/manager-events/apps/app_meetme.c Wed Jun 6 17:41:51 2012
@@ -1848,9 +1848,12 @@
/*** DOCUMENTATION
<managerEventInstance>
<synopsis>Raised when a MeetMe conference ends.</synopsis>
- <parameter name="Meetme">
- <para>The identifier for the Meetme conference.</para>
- </parameter>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter[@name='Meetme'])" />
+ </syntax>
+ <see-also>
+ <ref type="managerEvent">MeetmeJoin</ref>
+ </see-also>
</managerEventInstance>
***/
manager_event(EVENT_FLAG_CALL, "MeetmeEnd", "Meetme: %s\r\n", conf->confno);
@@ -2191,12 +2194,8 @@
<managerEventInstance>
<synopsis>Raised when a MeetMe user begins or ends talking.</synopsis>
<syntax>
- <parameter name="Meetme">
- <para>The identifier for the MeetMe conference.</para>
- </parameter>
- <parameter name="Usernum">
- <para>The identifier of the MeetMe user who started or ended talking.</para>
- </parameter>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter[@name='Meetme'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter[@name='Usernum'])" />
<parameter name="Status">
<enumlist>
<enum name="on"/>
@@ -2819,6 +2818,7 @@
</syntax>
<see-also>
<ref type="managerEvent">MeetmeLeave</ref>
+ <ref type="application">MeetMe</ref>
</see-also>
</managerEventInstance>
***/
@@ -3191,12 +3191,8 @@
<managerEventInstance>
<synopsis>Raised when a MeetMe user is muted.</synopsis>
<syntax>
- <parameter name="Meetme">
- <para>The identifier for the MeetMe conference.</para>
- </parameter>
- <parameter name="Usernum">
- <para>The identifier of the MeetMe user who joined.</para>
- </parameter>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter[@name='Meetme'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter[@name='Usernum'])" />
<parameter name="Status">
<enumlist>
<enum name="on"/>
@@ -3245,12 +3241,8 @@
<managerEventInstance>
<synopsis>Raised when a MeetMe user has started talking.</synopsis>
<syntax>
- <parameter name="Meetme">
- <para>The identifier for the MeetMe conference.</para>
- </parameter>
- <parameter name="Usernum">
- <para>The identifier of the MeetMe user who joined.</para>
- </parameter>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter[@name='Meetme'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter[@name='Usernum'])" />
<parameter name="Status">
<enumlist>
<enum name="on"/>
@@ -3944,12 +3936,8 @@
<managerEventInstance>
<synopsis>Raised when a user leaves a MeetMe conference.</synopsis>
<syntax>
- <parameter name="Meetme">
- <para>The identifier for the MeetMe conference.</para>
- </parameter>
- <parameter name="Usernum">
- <para>The identifier of the MeetMe user who joined.</para>
- </parameter>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter[@name='Meetme'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter[@name='Usernum'])" />
<parameter name="Duration">
<para>The length of time in seconds that the Meetme user was in the conference.</para>
</parameter>
Modified: team/mjordan/manager-events/apps/app_queue.c
URL: http://svnview.digium.com/svn/asterisk/team/mjordan/manager-events/apps/app_queue.c?view=diff&rev=368662&r1=368661&r2=368662
==============================================================================
--- team/mjordan/manager-events/apps/app_queue.c (original)
+++ team/mjordan/manager-events/apps/app_queue.c Wed Jun 6 17:41:51 2012
@@ -1582,6 +1582,45 @@
/*** DOCUMENTATION
<managerEventInstance>
<synopsis>Raised when a Queue member's status has changed.</synopsis>
+ <syntax>
+ <parameter name="Queue">
+ <para>The name of the queue.</para>
+ </parameter>
+ <parameter name="Location">
+ <para>The queue member's channel technology or location.</para>
+ </parameter>
+ <parameter name="MemberName">
+ <para>The name of the queue member.</para>
+ </parameter>
+ <parameter name="StateInterface">
+ <para>Channel technology or location from which to read device state changes.</para>
+ </parameter>
+ <parameter name="Membership">
+ <enumlist>
+ <enum name="dynamic"/>
+ <enum name="realtime"/>
+ <enum name="static"/>
+ </enumlist>
+ </parameter>
+ <parameter name="Penalty">
+ <para>The penalty associated with the queue member.</para>
+ </parameter>
+ <parameter name="CallsTaken">
+ <para>The number of calls this queue member has serviced.</para>
+ </parameter>
+ <parameter name="LastCall">
+ <para>The time this member last took call, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
+ </parameter>
+ <parameter name="Status">
+ <para>The status of the queue member. This will be a device state value.</para>
+ </parameter>
+ <parameter name="Paused">
+ <enumlist>
+ <enum name="0"/>
+ <enum name="1"/>
+ </enumlist>
+ </parameter>
+ </syntax>
</managerEventInstance>
***/
manager_event(EVENT_FLAG_AGENT, "QueueMemberStatus",
@@ -2748,8 +2787,18 @@
/*** DOCUMENTATION
<managerEventInstance>
<synopsis>Raised when a channel joins a Queue.</synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
+ <parameter name="Position">
+ <para>This channel's current position in the queue.</para>
+ </parameter>
+ <parameter name="Count">
+ <para>The total number of channels in the queue.</para>
+ </parameter>
+ </syntax>
<see-also>
<ref type="managerEvent">Leave</ref>
+ <ref type="application">Queue</ref>
</see-also>
</managerEventInstance>
***/
@@ -3043,6 +3092,11 @@
/*** DOCUMENTATION
<managerEventInstance>
<synopsis>Raised when a channel leaves a Queue.</synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='Join']/managerEventInstance/syntax/parameter[@name='Count'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='Join']/managerEventInstance/syntax/parameter[@name='Position'])" />
+ </syntax>
<see-also>
<ref type="managerEvent">Join</ref>
</see-also>
@@ -3450,6 +3504,28 @@
ast_channel_lock_both(tmp->chan, qe->chan);
+ /*** DOCUMENTATION
+ <managerEventInstance>
+ <synopsis>Raised when an Agent is notified of a member in the queue.</synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
+ <parameter name="AgentCalled">
+ <para>The agent's technology or location.</para>
+ </parameter>
+ <parameter name="AgentName">
+ <para>The name of the agent.</para>
+ </parameter>
+ <parameter name="Variable" required="no" multiple="yes">
+ <para>Optional channel variables from the ChannelCalling channel</para>
+ </parameter>
+ </syntax>
+ <see-also>
+ <ref type="managerEvent">AgentRingNoAnswer</ref>
+ <ref type="managerEvent">AgentComplete</ref>
+ <ref type="managerEvent">AgentConnect</ref>
+ </see-also>
+ </managerEventInstance>
+ ***/
manager_event(EVENT_FLAG_AGENT, "AgentCalled",
"Queue: %s\r\n"
"AgentCalled: %s\r\n"
@@ -3659,6 +3735,21 @@
{
set_queue_variables(qe->parent, qe->chan);
ao2_lock(qe->parent);
+ /*** DOCUMENTATION
+ <managerEventInstance>
+ <synopsis>Raised when an caller abandons the queue.</synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='Join']/managerEventInstance/syntax/parameter[@name='Position'])" />
+ <parameter name="OriginalPosition">
+ <para>The channel's original position in the queue.</para>
+ </parameter>
+ <parameter name="HoldTime">
+ <para>The time the channel was in the queue, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
+ </parameter>
+ </syntax>
+ </managerEventInstance>
+ ***/
manager_event(EVENT_FLAG_AGENT, "QueueCallerAbandon",
"Queue: %s\r\n"
"Uniqueid: %s\r\n"
@@ -3684,14 +3775,32 @@
if (qe->parent->eventwhencalled) {
char vars[2048];
-
+ /*** DOCUMENTATION
+ <managerEventInstance>
+ <synopsis>Raised when an agent is notified of a member in the queue and fails to answer.</synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='AgentCalled']/managerEventInstance/syntax/parameter[@name='Variable'])" />
+ <parameter name="Member">
+ <para>The queue member's channel technology or location.</para>
+ </parameter>
+ <parameter name="RingTime">
+ <para>The time the agent was rung, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
+ </parameter>
+ </syntax>
+ <see-also>
+ <ref type="managerEvent">AgentCalled</ref>
+ </see-also>
+ </managerEventInstance>
+ ***/
manager_event(EVENT_FLAG_AGENT, "AgentRingNoAnswer",
"Queue: %s\r\n"
"Uniqueid: %s\r\n"
"Channel: %s\r\n"
"Member: %s\r\n"
"MemberName: %s\r\n"
- "Ringtime: %d\r\n"
+ "RingTime: %d\r\n"
"%s",
qe->parent->name,
ast_channel_uniqueid(qe->chan),
@@ -4558,6 +4667,32 @@
break;
}
+ /*** DOCUMENTATION
+ <managerEventInstance>
+ <synopsis>Raised when an agent has finished servicing a member in the queue.</synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='AgentRingNoAnswer']/managerEventInstance/syntax/parameter[@name='Member'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueCallerAbandon']/managerEventInstance/syntax/parameter[@name='HoldTime'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='AgentCalled']/managerEventInstance/syntax/parameter[@name='Variable'])" />
+ <parameter name="TalkTime">
+ <para>The time the agent talked with the member in the queue, expressed in seconds since 00:00, Jan 1, 1970 UTC.</para>
+ </parameter>
+ <parameter name="Reason">
+ <enumlist>
+ <enum name="caller"/>
+ <enum name="agent"/>
+ <enum name="transfer"/>
+ </enumlist>
+ </parameter>
+ </syntax>
+ <see-also>
+ <ref type="managerEvent">AgentCalled</ref>
+ <ref type="managerEvent">AgentConnect</ref>
+ </see-also>
+ </managerEventInstance>
+ ***/
manager_event(EVENT_FLAG_AGENT, "AgentComplete",
"Queue: %s\r\n"
"Uniqueid: %s\r\n"
@@ -5101,6 +5236,21 @@
ast_log(LOG_WARNING, "Agent on %s hungup on the customer.\n", ast_channel_name(peer));
ast_queue_log(queuename, ast_channel_uniqueid(qe->chan), member->membername, "AGENTDUMP", "%s", "");
if (qe->parent->eventwhencalled)
+ /*** DOCUMENTATION
+ <managerEventInstance>
+ <synopsis>Raised when an agent hangs up on a member in the queue.</synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='AgentRingNoAnswer']/managerEventInstance/syntax/parameter[@name='Member'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='AgentCalled']/managerEventInstance/syntax/parameter[@name='Variable'])" />
+ </syntax>
+ <see-also>
+ <ref type="managerEvent">AgentCalled</ref>
+ <ref type="managerEvent">AgentConnect</ref>
+ </see-also>
+ </managerEventInstance>
+ ***/
manager_event(EVENT_FLAG_AGENT, "AgentDump",
"Queue: %s\r\n"
"Uniqueid: %s\r\n"
@@ -5416,15 +5566,33 @@
}
if (qe->parent->eventwhencalled)
+ /*** DOCUMENTATION
+ <managerEventInstance>
+ <synopsis>Raised when an agent answers and is bridged to a member in the queue.</synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='AgentRingNoAnswer']/managerEventInstance/syntax/parameter[@name='Member'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='AgentRingNoAnswer']/managerEventInstance/syntax/parameter[@name='RingTime'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueCallerAbandon']/managerEventInstance/syntax/parameter[@name='HoldTime'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='AgentCalled']/managerEventInstance/syntax/parameter[@name='Variable'])" />
+ </syntax>
+ <see-also>
+ <ref type="managerEvent">AgentCalled</ref>
+ <ref type="managerEvent">AgentComplete</ref>
+ <ref type="managerEvent">AgentDump</ref>
+ </see-also>
+ </managerEventInstance>
+ ***/
manager_event(EVENT_FLAG_AGENT, "AgentConnect",
"Queue: %s\r\n"
"Uniqueid: %s\r\n"
"Channel: %s\r\n"
"Member: %s\r\n"
"MemberName: %s\r\n"
- "Holdtime: %ld\r\n"
+ "HoldTime: %ld\r\n"
"BridgedChannel: %s\r\n"
- "Ringtime: %ld\r\n"
+ "RingTime: %ld\r\n"
"%s",
queuename, ast_channel_uniqueid(qe->chan), ast_channel_name(peer), member->interface, member->membername,
(long) time(NULL) - qe->start, ast_channel_uniqueid(peer), (long)(orig - to > 0 ? (orig - to) / 1000 : 0),
@@ -5627,6 +5795,20 @@
queue_t_unref(q, "Interface wasn't dynamic, expiring temporary reference");
return RES_NOT_DYNAMIC;
}
+ /*** DOCUMENTATION
+ <managerEventInstance>
+ <synopsis>Raised when a member is removed from the queue.</synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Location'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
+ </syntax>
+ <see-also>
+ <ref type="managerEvent">QueueMemberAdded</ref>
+ <ref type="application">RemoveQueueMember</ref>
+ </see-also>
+ </managerEventInstance>
+ ***/
manager_event(EVENT_FLAG_AGENT, "QueueMemberRemoved",
"Queue: %s\r\n"
"Location: %s\r\n"
@@ -5675,6 +5857,27 @@
new_member->ringinuse = q->ringinuse;
new_member->dynamic = 1;
ao2_link(q->members, new_member);
+ /*** DOCUMENTATION
+ <managerEventInstance>
+ <synopsis>Raised when a member is added to the queue.</synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Location'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='StateInterface'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Membership'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Penalty'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='CallsTaken'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='LastCall'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Status'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Paused'])" />
+ </syntax>
+ <see-also>
+ <ref type="managerEvent">QueueMemberRemoved</ref>
+ <ref type="application">AddQueueMember</ref>
+ </see-also>
+ </managerEventInstance>
+ ***/
manager_event(EVENT_FLAG_AGENT, "QueueMemberAdded",
"Queue: %s\r\n"
"Location: %s\r\n"
@@ -5755,6 +5958,21 @@
ast_queue_log(q->name, "NONE", mem->membername, (paused ? "PAUSE" : "UNPAUSE"), "%s", S_OR(reason, ""));
+ /*** DOCUMENTATION
+ <managerEventInstance>
+ <synopsis>Raised when a member is paused/unpaused in the queue with a reason.</synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Location'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Paused'])" />
+ </syntax>
+ <see-also>
+ <ref type="application">PauseQueueMember</ref>
+ <ref type="application">UnPauseQueueMember</ref>
+ </see-also>
+ </managerEventInstance>
+ ***/
if (!ast_strlen_zero(reason)) {
manager_event(EVENT_FLAG_AGENT, "QueueMemberPaused",
"Queue: %s\r\n"
@@ -5764,6 +5982,21 @@
"Reason: %s\r\n",
q->name, mem->interface, mem->membername, paused, reason);
} else {
+ /*** DOCUMENTATION
+ <managerEventInstance>
+ <synopsis>Raised when a member is paused/unpaused in the queue without a reason.</synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Location'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Paused'])" />
+ </syntax>
+ <see-also>
+ <ref type="application">PauseQueueMember</ref>
+ <ref type="application">UnPauseQueueMember</ref>
+ </see-also>
+ </managerEventInstance>
+ ***/
manager_event(EVENT_FLAG_AGENT, "QueueMemberPaused",
"Queue: %s\r\n"
"Location: %s\r\n"
@@ -5814,6 +6047,19 @@
update_realtime_member_field(mem, q->name, "penalty", rtpenalty);
}
ast_queue_log(q->name, "NONE", interface, "PENALTY", "%d", penalty);
+ /*** DOCUMENTATION
+ <managerEventInstance>
+ <synopsis>Raised when a member's penalty is changed.</synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Location'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Penalty'])" />
+ </syntax>
+ <see-also>
+ <ref type="function">QUEUE_MEMBER</ref>
+ </see-also>
+ </managerEventInstance>
+ ***/
manager_event(EVENT_FLAG_AGENT, "QueueMemberPenalty",
"Queue: %s\r\n"
"Location: %s\r\n"
@@ -5842,6 +6088,24 @@
update_realtime_member_field(mem, q->name, realtime_ringinuse_field, rtringinuse);
}
ast_queue_log(q->name, "NONE", interface, "RINGINUSE", "%d", ringinuse);
+ /*** DOCUMENTATION
+ <managerEventInstance>
+ <synopsis>Raised when a member's ringinuse setting is changed.</synopsis>
+ <syntax>
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
+ <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Location'])" />
+ <parameter name="Ringinuse">
+ <enumlist>
+ <enum name="0"/>
+ <enum name="1"/>
+ </enumlist>
+ </parameter>
+ </syntax>
+ <see-also>
+ <ref type="function">QUEUE_MEMBER</ref>
+ </see-also>
+ </managerEventInstance>
+ ***/
manager_event(EVENT_FLAG_AGENT, "QueueMemberRinginuse",
"Queue: %s\r\n"
"Location: %s\r\n"
Modified: team/mjordan/manager-events/apps/app_stack.c
URL: http://svnview.digium.com/svn/asterisk/team/mjordan/manager-events/apps/app_stack.c?view=diff&rev=368662&r1=368661&r2=368662
==============================================================================
--- team/mjordan/manager-events/apps/app_stack.c (original)
+++ team/mjordan/manager-events/apps/app_stack.c Wed Jun 6 17:41:51 2012
@@ -244,6 +244,14 @@
pbx_builtin_setvar_helper(chan, var, value);
}
+ /*** DOCUMENTATION
+ <managerEventInstance>
+ <synopsis>Raised when a LOCAL channel variable is set due to a subroutine call.</synopsis>
+ <see-also>
+ <ref type="application">GoSub</ref>
+ </see-also>
+ </managerEventInstance>
+ ***/
manager_event(EVENT_FLAG_DIALPLAN, "VarSet",
"Channel: %s\r\n"
"Variable: LOCAL(%s)\r\n"
Modified: team/mjordan/manager-events/apps/app_userevent.c
URL: http://svnview.digium.com/svn/asterisk/team/mjordan/manager-events/apps/app_userevent.c?view=diff&rev=368662&r1=368661&r2=368662
==============================================================================
--- team/mjordan/manager-events/apps/app_userevent.c (original)
+++ team/mjordan/manager-events/apps/app_userevent.c Wed Jun 6 17:41:51 2012
@@ -89,6 +89,17 @@
ast_str_append(&body, 0, "%s\r\n", args.extra[x]);
}
+ /*** DOCUMENTATION
+ <managerEventInstance>
+ <synopsis>A user defined event raised from the dialplan.</synopsis>
+ <parameter name="UserEvent">
+ <para>The event name, as specified in the dialplan.</para>
+ </parameter>
+ <see-also>
+ <ref type="application">UserEvent</ref>
+ </see-also>
+ </managerEventInstance>
+ ***/
manager_event(EVENT_FLAG_USER, "UserEvent",
"UserEvent: %s\r\n"
"Uniqueid: %s\r\n"
Modified: team/mjordan/manager-events/build_tools/get_documentation.py
URL: http://svnview.digium.com/svn/asterisk/team/mjordan/manager-events/build_tools/get_documentation.py?view=diff&rev=368662&r1=368661&r2=368662
==============================================================================
--- team/mjordan/manager-events/build_tools/get_documentation.py (original)
+++ team/mjordan/manager-events/build_tools/get_documentation.py Wed Jun 6 17:41:51 2012
@@ -74,17 +74,15 @@
parameter_tokens = event_parameters.replace("\"", "").split('\\r\\n')
- # Build the top level XML element information
- xml_fragment.insert(0, "<managerEvent language=\"%s\" name=\"%s\">" %
+ # Build the top level XML element information. Note that we temporarily
+ # add the xi namespace in case any includes are used
+ xml_fragment.insert(0, "<managerEvent language=\"%s\" name=\"%s\" xmlns:xi=\"http://www.w3.org/2001/XInclude\">" %
('en_US', event_type.strip().replace("\"","")))
xml_fragment[1] = "<managerEventInstance class=\"%s\">" % (class_level)
xml_fragment.insert(len(xml_fragment), "</managerEvent>")
# Turn the XML into a DOM to manage the rest of the node manipulations
dom = xml.dom.minidom.parseString(''.join(xml_fragment))
- el = dom.createElementNS('http://www.w3.org/2001/XInclude', 'xi')
- el.setAttribute('xmlns', 'http://www.w3.org/2001/XInclude')
- dom.appendChild(el)
# Get the syntax node if we have one; otherwise make one
instance = dom.getElementsByTagName("managerEventInstance")[0]
@@ -104,14 +102,18 @@
for parameter in parameter_tokens:
if not parameter:
continue
- parameter = (parameter.strip().replace("\"",""))[:parameter.index(":")]
- if not any([node for node in syntax.getElementsByTagName("parameter") if
- any([attr for attr in node.attributes.items() if attr[1] == parameter])]):
+ index = parameter.find(':')
+ if index < 0:
+ index = len(parameter)
+ parameter = (parameter.strip().replace("\"",""))[:index]
+ if ('%s' not in parameter and
+ not any([node for node in syntax.getElementsByTagName("parameter") if
+ any([attr for attr in node.attributes.items() if attr[1] == parameter])])):
e = dom.createElement("parameter")
e.setAttribute('name', parameter)
syntax.appendChild(e)
- return dom.toxml().replace("<?xml version=\"1.0\" ?>", "")
+ return dom.toxml().replace("<?xml version=\"1.0\" ?>", "").replace('xmlns:xi="http://www.w3.org/2001/XInclude"', '')
def main(argv=None):
Modified: team/mjordan/manager-events/build_tools/make_version
URL: http://svnview.digium.com/svn/asterisk/team/mjordan/manager-events/build_tools/make_version?view=diff&rev=368662&r1=368661&r2=368662
==============================================================================
--- team/mjordan/manager-events/build_tools/make_version (original)
+++ team/mjordan/manager-events/build_tools/make_version Wed Jun 6 17:41:51 2012
@@ -7,6 +7,7 @@
BRANCH=0
TEAM=0
TAG=0
+ FEATURE=0
REV=`svnversion -c ${1} | cut -d: -f2`
@@ -40,6 +41,9 @@
else
RESULT="${RESULT}-${PART}"
fi
+ if [ ${FEATURE} != 0 ] ; then
+ RESULT="${RESULT}-${FEATURE_NAME}"
+ fi
break
fi
@@ -49,6 +53,12 @@
else
RESULT="${RESULT}-${PART}"
fi
+ continue
+ fi
+
+ if [ "${PART}" = "certified" ] ; then
+ FEATURE=1
+ FEATURE_NAME="cert"
continue
fi
Modified: team/mjordan/manager-events/main/xmldoc.c
URL: http://svnview.digium.com/svn/asterisk/team/mjordan/manager-events/main/xmldoc.c?view=diff&rev=368662&r1=368661&r2=368662
==============================================================================
--- team/mjordan/manager-events/main/xmldoc.c (original)
+++ team/mjordan/manager-events/main/xmldoc.c Wed Jun 6 17:41:51 2012
@@ -1067,7 +1067,7 @@
}
/* Is this parameter required? */
- required = 0;
+ required = !strcasecmp(manager_type, "event") ? 1 : 0;
paramtype = ast_xml_get_attribute(node, "required");
if (paramtype) {
required = ast_true(paramtype);
@@ -1080,15 +1080,10 @@
continue;
}
- if (!strcasecmp(manager_type, "event")) {
- ast_str_append(&syntax, 0, "\n%s: <value>",
- attrname);
- } else {
- ast_str_append(&syntax, 0, "\n%s%s:%s <value>",
- (required ? "" : "["),
- attrname,
- (required ? "" : "]"));
- }
+ ast_str_append(&syntax, 0, "\n%s%s:%s <value>",
+ (required ? "" : "["),
+ attrname,
+ (required ? "" : "]"));
ast_xml_free_attr(attrname);
}
More information about the asterisk-commits
mailing list