Merge a set of device state improvements from team/russell/events.
[asterisk/asterisk.git] / include / asterisk / devicestate.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Device state management
21  *
22  * To subscribe to device state changes, use the generic ast_event_subscribe
23  * method.  For an example, see apps/app_queue.c.
24  *
25  * \todo Currently, when the state of a device changes, the device state provider
26  * calls one of the functions defined here to queue an object to say that the 
27  * state of a device has changed.  However, this does not include the new state.
28  * Another thread processes these device state change objects and calls the
29  * device state provider's callback to figure out what the new state is.  It
30  * would make a lot more sense for the new state to be included in the original
31  * function call that says the state of a device has changed.  However, it
32  * will take a lot of work to change this.
33  *
34  * \arg See \ref AstExtState
35  */
36
37 #ifndef _ASTERISK_DEVICESTATE_H
38 #define _ASTERISK_DEVICESTATE_H
39
40 #if defined(__cplusplus) || defined(c_plusplus)
41 extern "C" {
42 #endif
43
44 /*! Device States 
45  *  \note The order of these states may not change because they are included
46  *        in Asterisk events which may be transmitted across the network to
47  *        other servers.
48  */
49 enum ast_device_state {
50         AST_DEVICE_UNKNOWN,      /*!< Device is valid but channel didn't know state */
51         AST_DEVICE_NOT_INUSE,    /*!< Device is not used */
52         AST_DEVICE_INUSE,        /*!< Device is in use */
53         AST_DEVICE_BUSY,         /*!< Device is busy */
54         AST_DEVICE_INVALID,      /*!< Device is invalid */
55         AST_DEVICE_UNAVAILABLE,  /*!< Device is unavailable */
56         AST_DEVICE_RINGING,      /*!< Device is ringing */
57         AST_DEVICE_RINGINUSE,    /*!< Device is ringing *and* in use */
58         AST_DEVICE_ONHOLD,       /*!< Device is on hold */
59 };
60
61 /*! \brief Devicestate provider call back */
62 typedef enum ast_device_state (*ast_devstate_prov_cb_type)(const char *data);
63
64 /*! 
65  * \brief Convert device state to text string for output 
66  *
67  * \param devstate Current device state 
68  */
69 const char *devstate2str(enum ast_device_state devstate);
70
71 /*! 
72  * \brief Convert device state to text string that is easier to parse 
73  *
74  * \param devstate Current device state 
75  */
76 const char *ast_devstate_str(enum ast_device_state devstate);
77
78 /*! 
79  * \brief Convert device state from text to integer value
80  *
81  * \param val The text representing the device state.  Valid values are anything
82  *        that comes after AST_DEVICE_ in one of the defined values.
83  *
84  * \return The AST_DEVICE_ integer value
85  */
86 enum ast_device_state ast_devstate_val(const char *val);
87
88 /*! 
89  * \brief Search the Channels by Name
90  *
91  * \param device like a dial string
92  *
93  * Search the Device in active channels by compare the channel name against 
94  * the device name. Compared are only the first chars to the first '-' char.
95  *
96  * \retval AST_DEVICE_UNKNOWN if no channel found
97  * \retval AST_DEVICE_INUSE if a channel is found
98  */
99 enum ast_device_state ast_parse_device_state(const char *device);
100
101 /*! 
102  * \brief Asks a channel for device state
103  *
104  * \param device like a dial string
105  *
106  * Asks a channel for device state, data is normally a number from a dial string
107  * used by the low level module
108  * Tries the channel device state callback if not supported search in the
109  * active channels list for the device.
110  *
111  * \retval an AST_DEVICE_??? state 
112  * \retval -1 on failure
113  */
114 enum ast_device_state ast_device_state(const char *device);
115
116 /*! 
117  * \brief Tells Asterisk the State for Device is changed
118  *
119  * \param state the new state of the device
120  * \param fmt device name like a dial string with format parameters
121  *
122  * The new state of the device will be sent off to any subscribers
123  * of device states.  It will also be stored in the internal event
124  * cache.
125  *
126  * \retval 0 on success 
127  * \retval -1 on failure
128  *
129  * \note This is deprecated in favor of ast_devstate_changed()
130  */
131 int ast_devstate_changed(enum ast_device_state state, const char *fmt, ...)
132         __attribute__ ((format (printf, 2, 3)));
133
134 /*! 
135  * \brief Tells Asterisk the State for Device is changed
136  *
137  * \param state the new state of the device
138  * \param fmt device name like a dial string with format parameters
139  *
140  * The new state of the device will be sent off to any subscribers
141  * of device states.  It will also be stored in the internal event
142  * cache.
143  *
144  * \retval 0 on success 
145  * \retval -1 on failure
146  *
147  * \note This is deprecated in favor of ast_devstate_changed()
148  */
149 int ast_devstate_changed_literal(enum ast_device_state state, const char *device);
150
151 /*! 
152  * \brief Tells Asterisk the State for Device is changed
153  *
154  * \param fmt device name like a dial string with format parameters
155  *
156  * Asterisk polls the new extension states and calls the registered
157  * callbacks for the changed extensions
158  *
159  * \retval 0 on success 
160  * \retval -1 on failure
161  *
162  * \note This is deprecated in favor of ast_devstate_changed()
163  */
164 int ast_device_state_changed(const char *fmt, ...)
165         __attribute__ ((format (printf, 1, 2)));
166
167 /*! 
168  * \brief Tells Asterisk the State for Device is changed 
169  *
170  * \param device device name like a dial string
171  *
172  * Asterisk polls the new extension states and calls the registered
173  * callbacks for the changed extensions
174  *
175  * \retval 0 on success 
176  * \retval -1 on failure
177  *
178  * \note This is deprecated in favor of ast_devstate_changed_literal()
179  */
180 int ast_device_state_changed_literal(const char *device);
181
182 /*! 
183  * \brief Add device state provider 
184  *
185  * \param label to use in hint, like label:object
186  * \param callback Callback
187  *
188  * \retval 0 success
189  * \retval -1 failure
190  */ 
191 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback);
192
193 /*! 
194  * \brief Remove device state provider 
195  *
196  * \param label to use in hint, like label:object
197  *
198  * \retval -1 on failure 
199  * \retval 0 on success
200  */ 
201 int ast_devstate_prov_del(const char *label);
202
203 #if defined(__cplusplus) || defined(c_plusplus)
204 }
205 #endif
206
207 #endif /* _ASTERISK_DEVICESTATE_H */