diff options
| author | Matthew Jordan <mjordan@digium.com> | 2012-07-10 22:26:27 +0000 |
|---|---|---|
| committer | Matthew Jordan <mjordan@digium.com> | 2012-07-10 22:26:27 +0000 |
| commit | 2ffae5745d6d68f1599f4dfbf0ead131cf5acc32 (patch) | |
| tree | 1304cf10595e850a33e2dbb2458a2819751bc1ce /channels/chan_dahdi.c | |
| parent | 3805e2ae4d654a24f7c98fc6f41dcec81d02670e (diff) | |
Add some additional documentation for core AMI events
This patch adds some basic documentation for a number of modules. This
includes core source files in Asterisk (those in main), as well as
chan_agent, chan_dahdi, chan_local, sig_analog, and sig_pri. The DTD
has also been updated to allow referencing of AMI commands.
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@369905 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'channels/chan_dahdi.c')
| -rw-r--r-- | channels/chan_dahdi.c | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/channels/chan_dahdi.c b/channels/chan_dahdi.c index 59841d1bd..b15caa5be 100644 --- a/channels/chan_dahdi.c +++ b/channels/chan_dahdi.c @@ -2175,6 +2175,11 @@ static void dahdi_ami_channel_event(struct dahdi_pvt *p, struct ast_channel *cha /* Real channel */ snprintf(ch_name, sizeof(ch_name), "%d", p->channel); } + /*** DOCUMENTATION + <managerEventInstance> + <synopsis>Raised when a DAHDI channel is created or an underlying technology is associated with a DAHDI channel.</synopsis> + </managerEventInstance> + ***/ ast_manager_event(chan, EVENT_FLAG_CALL, "DAHDIChannel", "Channel: %s\r\n" "Uniqueid: %s\r\n" @@ -3866,10 +3871,20 @@ static void handle_clear_alarms(struct dahdi_pvt *p) if (report_alarms & REPORT_CHANNEL_ALARMS) { ast_log(LOG_NOTICE, "Alarm cleared on channel %d\n", p->channel); + /*** DOCUMENTATION + <managerEventInstance> + <synopsis>Raised when an alarm is cleared on a DAHDI channel.</synopsis> + </managerEventInstance> + ***/ manager_event(EVENT_FLAG_SYSTEM, "AlarmClear", "Channel: %d\r\n", p->channel); } if (report_alarms & REPORT_SPAN_ALARMS && p->manages_span_alarms) { ast_log(LOG_NOTICE, "Alarm cleared on span %d\n", p->span); + /*** DOCUMENTATION + <managerEventInstance> + <synopsis>Raised when an alarm is cleared on a DAHDI span.</synopsis> + </managerEventInstance> + ***/ manager_event(EVENT_FLAG_SYSTEM, "SpanAlarmClear", "Span: %d\r\n", p->span); } } @@ -7972,6 +7987,11 @@ static void handle_alarms(struct dahdi_pvt *p, int alms) alarm_str = alarm2str(alms); if (report_alarms & REPORT_CHANNEL_ALARMS) { ast_log(LOG_WARNING, "Detected alarm on channel %d: %s\n", p->channel, alarm_str); + /*** DOCUMENTATION + <managerEventInstance> + <synopsis>Raised when an alarm is set on a DAHDI channel.</synopsis> + </managerEventInstance> + ***/ manager_event(EVENT_FLAG_SYSTEM, "Alarm", "Alarm: %s\r\n" "Channel: %d\r\n", @@ -7980,6 +8000,11 @@ static void handle_alarms(struct dahdi_pvt *p, int alms) if (report_alarms & REPORT_SPAN_ALARMS && p->manages_span_alarms) { ast_log(LOG_WARNING, "Detected alarm on span %d: %s\n", p->span, alarm_str); + /*** DOCUMENTATION + <managerEventInstance> + <synopsis>Raised when an alarm is set on a DAHDI span.</synopsis> + </managerEventInstance> + ***/ manager_event(EVENT_FLAG_SYSTEM, "SpanAlarm", "Alarm: %s\r\n" "Span: %d\r\n", @@ -10027,6 +10052,19 @@ static int dahdi_dnd(struct dahdi_pvt *dahdichan, int flag) ast_verb(3, "%s DND on channel %d\n", flag? "Enabled" : "Disabled", dahdichan->channel); + /*** DOCUMENTATION + <managerEventInstance> + <synopsis>Raised when the Do Not Disturb state is changed on a DAHDI channel.</synopsis> + <syntax> + <parameter name="Status"> + <enumlist> + <enum name="enabled"/> + <enum name="disabled"/> + </enumlist> + </parameter> + </syntax> + </managerEventInstance> + ***/ manager_event(EVENT_FLAG_SYSTEM, "DNDState", "Channel: DAHDI/%d\r\n" "Status: %s\r\n", dahdichan->channel, |