Monitor.notify
From Yate Documentation
(Difference between revisions)
(Created page with " '''monitor.notify''' message is emitted by the monitoring module to announce the values for certain monitored data (usually when a notification threshold has been surpassed)....") |
(→Message parameters) |
||
| Line 8: | Line 8: | ||
;count | ;count | ||
| − | : the number of notifications contained in the message for this data entry. It is at least 1. It can be thought of like the number of columns for the data entry at line index. For the number specified by count, there will be that number of notify.i - value.i pairs of message parameters which specify a notification and its value where i = 0..(count - 1). | + | : the number of notifications contained in the message for this data entry. It is at least 1. It can be thought of like the number of columns for the data entry at line index. For the number specified by count, there will be that number of ''notify.i - value.i'' pairs of message parameters which specify a notification and its value where ''i = 0..(count - 1)''. |
;notify.0 | ;notify.0 | ||
| − | : the name of the data that is sent as a notification. If count is greater than 1, it continues with notify.1,notify.2 until notify.(count-1), otherwise only this notification will be present. | + | : the name of the data that is sent as a notification. If count is greater than 1, it continues with ''notify.1'',''notify.2'' until ''notify.(count-1)'', otherwise only this notification will be present. |
;value.0 | ;value.0 | ||
| − | : the value for the data named by notify.0. If count is greater than 1, it continues with value.1,value.2 until value.(count-1), otherwise only this value parameter will be present. | + | : the value for the data named by ''notify.0''. If count is greater than 1, it continues with ''value.1'',''value.2'' until ''value.(count-1)'', otherwise only this value parameter will be present. |
===Return=== | ===Return=== | ||
The monitoring module does not expect this message to be acknowledged. | The monitoring module does not expect this message to be acknowledged. | ||
Revision as of 16:02, 15 November 2012
monitor.notify message is emitted by the monitoring module to announce the values for certain monitored data (usually when a notification threshold has been surpassed).
Message parameters
- index
- the index of the entry in a table for which this notification was sent. It specifies the line index for an entry in a table. Indexing starts at 1 for tables. For notifications about data that is not kept in a table (i.e. alarm notifications), the index is 0.
- count
- the number of notifications contained in the message for this data entry. It is at least 1. It can be thought of like the number of columns for the data entry at line index. For the number specified by count, there will be that number of notify.i - value.i pairs of message parameters which specify a notification and its value where i = 0..(count - 1).
- notify.0
- the name of the data that is sent as a notification. If count is greater than 1, it continues with notify.1,notify.2 until notify.(count-1), otherwise only this notification will be present.
- value.0
- the value for the data named by notify.0. If count is greater than 1, it continues with value.1,value.2 until value.(count-1), otherwise only this value parameter will be present.
Return
The monitoring module does not expect this message to be acknowledged.
