[Asterisk-code-review] manager.c: Update AMI Status event documentation (asterisk[13])

[Jenkins2]

Jenkins2 has submitted this change and it was merged. ( https://gerrit.asterisk.org/7747 )

Change subject: manager.c: Update AMI Status event documentation
......................................................................

manager.c: Update AMI Status event documentation

The AMI Status event had linkedid listed twice and was missing the
effective connected line name and number headers.

NOTE: The linkedid and other standard channel snapshot fields in the XML
documentation are part of the <channel_snapshot/> XML template defined in
doc/appdocsxml.xslt.

* Cached the effective connected line party id so it doesn't get
calculated four times.

Change-Id: I004c4c4f9e7b40ef55035c831702721bec82496c
---
M main/manager.c
1 file changed, 14 insertions(+), 6 deletions(-)

Approvals:
  George Joseph: Looks good to me, but someone else must approve
  Sean Bright: Looks good to me, approved
  Jenkins2: Approved for Submit



diff --git a/main/manager.c b/main/manager.c
index 890a975..4e611a0 100644
--- a/main/manager.c
+++ b/main/manager.c
@@ -247,13 +247,15 @@
 				<parameter name="DNID">
 					<para>Dialed number identifier</para>
 				</parameter>
+				<parameter name="EffectiveConnectedLineNum">
+				</parameter>
+				<parameter name="EffectiveConnectedLineName">
+				</parameter>
 				<parameter name="TimeToHangup">
 					<para>Absolute lifetime of the channel</para>
 				</parameter>
 				<parameter name="BridgeID">
 					<para>Identifier of the bridge the channel is in, may be empty if not in one</para>
-				</parameter>
-				<parameter name="Linkedid">
 				</parameter>
 				<parameter name="Application">
 					<para>Application currently executing on the channel</para>
@@ -4583,6 +4585,7 @@
 		struct timeval now;
 		long elapsed_seconds;
 		struct ast_bridge *bridge;
+		struct ast_party_id effective_id;
 
 		ast_channel_lock(chan);
 
@@ -4611,10 +4614,12 @@
 		channels++;
 
 		bridge = ast_channel_get_bridge(chan);
+		effective_id = ast_channel_connected_effective_id(chan);
 
 		astman_append(s,
 			"Event: Status\r\n"
 			"Privilege: Call\r\n"
+			/* v-- Start channel snapshot headers */
 			"Channel: %s\r\n"
 			"ChannelState: %u\r\n"
 			"ChannelStateDesc: %s\r\n"
@@ -4627,13 +4632,14 @@
 			"Exten: %s\r\n"
 			"Priority: %d\r\n"
 			"Uniqueid: %s\r\n"
+			"Linkedid: %s\r\n"
+			/* ^-- End channel snapshot headers */
 			"Type: %s\r\n"
 			"DNID: %s\r\n"
 			"EffectiveConnectedLineNum: %s\r\n"
 			"EffectiveConnectedLineName: %s\r\n"
 			"TimeToHangup: %ld\r\n"
 			"BridgeID: %s\r\n"
-			"Linkedid: %s\r\n"
 			"Application: %s\r\n"
 			"Data: %s\r\n"
 			"Nativeformats: %s\r\n"
@@ -4647,6 +4653,7 @@
 			"%s"
 			"%s"
 			"\r\n",
+			/* v-- Start channel snapshot headers */
 			ast_channel_name(chan),
 			ast_channel_state(chan),
 			ast_state2str(ast_channel_state(chan)),
@@ -4659,13 +4666,14 @@
 			ast_channel_exten(chan),
 			ast_channel_priority(chan),
 			ast_channel_uniqueid(chan),
+			ast_channel_linkedid(chan),
+			/* ^-- End channel snapshot headers */
 			ast_channel_tech(chan)->type,
 			S_OR(ast_channel_dialed(chan)->number.str, ""),
-			S_COR(ast_channel_connected_effective_id(chan).number.valid, ast_channel_connected_effective_id(chan).number.str, "<unknown>"),
-			S_COR(ast_channel_connected_effective_id(chan).name.valid, ast_channel_connected_effective_id(chan).name.str, "<unknown>"),
+			S_COR(effective_id.number.valid, effective_id.number.str, "<unknown>"),
+			S_COR(effective_id.name.valid, effective_id.name.str, "<unknown>"),
 			(long)ast_channel_whentohangup(chan)->tv_sec,
 			bridge ? bridge->uniqueid : "",
-			ast_channel_linkedid(chan),
 			ast_channel_appl(chan),
 			ast_channel_data(chan),
 			ast_format_cap_get_names(ast_channel_nativeformats(chan), &codec_buf),

-- 
To view, visit https://gerrit.asterisk.org/7747
To unsubscribe, visit https://gerrit.asterisk.org/settings

Gerrit-Project: asterisk
Gerrit-Branch: 13
Gerrit-MessageType: merged
Gerrit-Change-Id: I004c4c4f9e7b40ef55035c831702721bec82496c
Gerrit-Change-Number: 7747
Gerrit-PatchSet: 3
Gerrit-Owner: Richard Mudgett <rmudgett at digium.com>
Gerrit-Reviewer: Corey Farrell <git at cfware.com>
Gerrit-Reviewer: George Joseph <gjoseph at digium.com>
Gerrit-Reviewer: Jenkins2
Gerrit-Reviewer: Richard Mudgett <rmudgett at digium.com>
Gerrit-Reviewer: Sean Bright <sean.bright at gmail.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20171228/f42b9ccb/attachment.html>