Merged revisions 204681 via svnmerge from
[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 #include "asterisk/channel.h"
41
42 #if defined(__cplusplus) || defined(c_plusplus)
43 extern "C" {
44 #endif
45
46 /*! \brief Device States
47  *  \note The order of these states may not change because they are included
48  *        in Asterisk events which may be transmitted across the network to
49  *        other servers.
50  */
51 enum ast_device_state {
52         AST_DEVICE_UNKNOWN,      /*!< Device is valid but channel didn't know state */
53         AST_DEVICE_NOT_INUSE,    /*!< Device is not used */
54         AST_DEVICE_INUSE,        /*!< Device is in use */
55         AST_DEVICE_BUSY,         /*!< Device is busy */
56         AST_DEVICE_INVALID,      /*!< Device is invalid */
57         AST_DEVICE_UNAVAILABLE,  /*!< Device is unavailable */
58         AST_DEVICE_RINGING,      /*!< Device is ringing */
59         AST_DEVICE_RINGINUSE,    /*!< Device is ringing *and* in use */
60         AST_DEVICE_ONHOLD,       /*!< Device is on hold */
61         AST_DEVICE_TOTAL,        /*/ Total num of device states, used for testing */
62 };
63
64 /*! \brief Devicestate provider call back */
65 typedef enum ast_device_state (*ast_devstate_prov_cb_type)(const char *data);
66
67 /*!
68  * \brief Convert channel state to devicestate
69  *
70  * \param chanstate Current channel state
71  * \since 1.6.1
72  */
73 enum ast_device_state ast_state_chan2dev(enum ast_channel_state chanstate);
74
75 /*!
76  * \brief Convert device state to text string for output
77  *
78  * \param devstate Current device state
79  */
80 const char *devstate2str(enum ast_device_state devstate) attribute_pure __attribute__((deprecated));
81 const char *ast_devstate2str(enum ast_device_state devstate) attribute_pure;
82
83 /*!
84  * \brief Convert device state to text string that is easier to parse
85  *
86  * \param devstate Current device state
87  */
88 const char *ast_devstate_str(enum ast_device_state devstate) attribute_pure;
89
90 /*!
91  * \brief Convert device state from text to integer value
92  *
93  * \param val The text representing the device state.  Valid values are anything
94  *        that comes after AST_DEVICE_ in one of the defined values.
95  *
96  * \return The AST_DEVICE_ integer value
97  */
98 enum ast_device_state ast_devstate_val(const char *val);
99
100 /*!
101  * \brief Search the Channels by Name
102  *
103  * \param device like a dial string
104  *
105  * Search the Device in active channels by compare the channel name against
106  * the device name. Compared are only the first chars to the first '-' char.
107  *
108  * \retval AST_DEVICE_UNKNOWN if no channel found
109  * \retval AST_DEVICE_INUSE if a channel is found
110  */
111 enum ast_device_state ast_parse_device_state(const char *device);
112
113 /*!
114  * \brief Asks a channel for device state
115  *
116  * \param device like a dial string
117  *
118  * Asks a channel for device state, data is normally a number from a dial string
119  * used by the low level module
120  * Tries the channel device state callback if not supported search in the
121  * active channels list for the device.
122  *
123  * \retval an AST_DEVICE_??? state
124  * \retval -1 on failure
125  */
126 enum ast_device_state ast_device_state(const char *device);
127
128 /*!
129  * \brief Tells Asterisk the State for Device is changed
130  *
131  * \param state the new state of the device
132  * \param fmt device name like a dial string with format parameters
133  *
134  * The new state of the device will be sent off to any subscribers
135  * of device states.  It will also be stored in the internal event
136  * cache.
137  *
138  * \retval 0 on success
139  * \retval -1 on failure
140  */
141 int ast_devstate_changed(enum ast_device_state state, const char *fmt, ...)
142         __attribute__((format(printf, 2, 3)));
143
144 /*!
145  * \brief Tells Asterisk the State for Device is changed
146  *
147  * \param state the new state of the device
148  * \param device device name like a dial string with format parameters
149  *
150  * The new state of the device will be sent off to any subscribers
151  * of device states.  It will also be stored in the internal event
152  * cache.
153  *
154  * \retval 0 on success
155  * \retval -1 on failure
156  */
157 int ast_devstate_changed_literal(enum ast_device_state state, const char *device);
158
159 /*!
160  * \brief Tells Asterisk the State for Device is changed.
161  * (Accept change notification, add it to change queue.)
162  *
163  * \param fmt device name like a dial string with format parameters
164  *
165  * Asterisk polls the new extension states and calls the registered
166  * callbacks for the changed extensions
167  *
168  * \retval 0 on success
169  * \retval -1 on failure
170  *
171  * \note This is deprecated in favor of ast_devstate_changed()
172  * \version 1.6.1 deprecated
173  */
174 int ast_device_state_changed(const char *fmt, ...)
175         __attribute__((deprecated,format(printf, 1, 2)));
176
177 /*!
178  * \brief Tells Asterisk the State for Device is changed
179  *
180  * \param device device name like a dial string
181  *
182  * Asterisk polls the new extension states and calls the registered
183  * callbacks for the changed extensions
184  *
185  * \retval 0 on success
186  * \retval -1 on failure
187  *
188  * \note This is deprecated in favor of ast_devstate_changed_literal()
189  * \version 1.6.1 deprecated
190  */
191 int ast_device_state_changed_literal(const char *device)
192         __attribute__((deprecated));
193
194 /*!
195  * \brief Add device state provider
196  *
197  * \param label to use in hint, like label:object
198  * \param callback Callback
199  *
200  * \retval 0 success
201  * \retval -1 failure
202  */
203 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback);
204
205 /*!
206  * \brief Remove device state provider
207  *
208  * \param label to use in hint, like label:object
209  *
210  * \retval -1 on failure
211  * \retval 0 on success
212  */
213 int ast_devstate_prov_del(const char *label);
214
215 /*!
216  * \brief An object to hold state when calculating aggregate device state
217  */
218 struct ast_devstate_aggregate;
219
220 /*!
221  * \brief Initialize aggregate device state
222  *
223  * \param[in] agg the state object
224  *
225  * \return nothing
226  * \since 1.6.1
227  */
228 void ast_devstate_aggregate_init(struct ast_devstate_aggregate *agg);
229
230 /*!
231  * \brief Add a device state to the aggregate device state
232  *
233  * \param[in] agg the state object
234  * \param[in] state the state to add
235  *
236  * \return nothing
237  * \since 1.6.1
238  */
239 void ast_devstate_aggregate_add(struct ast_devstate_aggregate *agg, enum ast_device_state state);
240
241 /*!
242  * \brief Get the aggregate device state result
243  *
244  * \param[in] agg the state object
245  *
246  * \return the aggregate device state after adding some number of device states.
247  * \since 1.6.1
248  */
249 enum ast_device_state ast_devstate_aggregate_result(struct ast_devstate_aggregate *agg);
250
251 /*!
252  * \brief Map devstate to an extension state.
253  *
254  * \param[in] device state
255  *
256  * \return the extension state mapping.
257  */
258 enum ast_extension_states ast_devstate_to_extenstate(enum ast_device_state devstate);
259
260 /*!
261  * \brief You shouldn't care about the contents of this struct
262  *
263  * This struct is only here so that it can be easily declared on the stack.
264  */
265 struct ast_devstate_aggregate {
266         unsigned int all_unknown:1;
267         unsigned int all_unavail:1;
268         unsigned int all_busy:1;
269         unsigned int all_free:1;
270         unsigned int on_hold:1;
271         unsigned int busy:1;
272         unsigned int in_use:1;
273         unsigned int ring:1;
274 };
275
276 /*!
277  * \brief Enable distributed device state processing.
278  *
279  * \details
280  * By default, Asterisk assumes that device state change events will only be
281  * originating from one instance.  If a module gets loaded and configured such
282  * that multiple instances of Asterisk will be sharing device state, this
283  * function should be called to enable distributed device state processing.
284  * It is off by default to save on unnecessary processing.
285  *
286  * \retval 0 success
287  * \retval -1 failure
288  */
289 int ast_enable_distributed_devstate(void);
290
291 #if defined(__cplusplus) || defined(c_plusplus)
292 }
293 #endif
294
295 #endif /* _ASTERISK_DEVICESTATE_H */