Monitor.query
From Yate Documentation
(Difference between revisions)
(Created page with " ''' monitor.query''' message is used to query the monitoring module in order to retrieve the value of some monitored data. ===Message parameters=== ;name : the name of t...") |
(→Return parameters) |
||
| Line 18: | Line 18: | ||
;value | ;value | ||
: the value asked for by the query. It will be empty if the specified name for the query is a name of which the monitor has no knowledge of. | : the value asked for by the query. It will be empty if the specified name for the query is a name of which the monitor has no knowledge of. | ||
| + | |||
| + | |||
| + | '''See also''' | ||
| + | |||
| + | *[[monitor.value]] | ||
Revision as of 12:59, 23 January 2013
monitor.query message is used to query the monitoring module in order to retrieve the value of some monitored data.
Message parameters
- name
- the name of the query. It specifies which value you wish to retrieve. A query like name=databaseCount will ask for the number of monitored database accounts.
- index
- the index of the value you wish to retrieve. If the value you are asking for it's in a table you should specify for which entry from the table you want the data. Indexing for tables starts at 1. If "index" is not specified, it is assumed to be 0.
Return
The monitoring module will acknowledge this message if the name of the query is at least specified.
Return parameters
- value
- the value asked for by the query. It will be empty if the specified name for the query is a name of which the monitor has no knowledge of.
See also
