fe911bacfe87556fd159292275d41de281aea384
[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 /*! \brief 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 channel state to devicestate
66  *
67  * \param chanstate Current channel state
68  * \since 1.6.1
69  */
70 enum ast_device_state ast_state_chan2dev(enum ast_channel_state chanstate);
71
72 /*!
73  * \brief Convert device state to text string for output
74  *
75  * \param devstate Current device state
76  */
77 const char *devstate2str(enum ast_device_state devstate) attribute_pure __attribute__((deprecated));
78 const char *ast_devstate2str(enum ast_device_state devstate) attribute_pure;
79
80 /*!
81  * \brief Convert device state to text string that is easier to parse
82  *
83  * \param devstate Current device state
84  */
85 const char *ast_devstate_str(enum ast_device_state devstate) attribute_pure;
86
87 /*!
88  * \brief Convert device state from text to integer value
89  *
90  * \param val The text representing the device state.  Valid values are anything
91  *        that comes after AST_DEVICE_ in one of the defined values.
92  *
93  * \return The AST_DEVICE_ integer value
94  */
95 enum ast_device_state ast_devstate_val(const char *val);
96
97 /*!
98  * \brief Search the Channels by Name
99  *
100  * \param device like a dial string
101  *
102  * Search the Device in active channels by compare the channel name against
103  * the device name. Compared are only the first chars to the first '-' char.
104  *
105  * \retval AST_DEVICE_UNKNOWN if no channel found
106  * \retval AST_DEVICE_INUSE if a channel is found
107  */
108 enum ast_device_state ast_parse_device_state(const char *device);
109
110 /*!
111  * \brief Asks a channel for device state
112  *
113  * \param device like a dial string
114  *
115  * Asks a channel for device state, data is normally a number from a dial string
116  * used by the low level module
117  * Tries the channel device state callback if not supported search in the
118  * active channels list for the device.
119  *
120  * \retval an AST_DEVICE_??? state
121  * \retval -1 on failure
122  */
123 enum ast_device_state ast_device_state(const char *device);
124
125 /*!
126  * \brief Tells Asterisk the State for Device is changed
127  *
128  * \param state the new state of the device
129  * \param fmt device name like a dial string with format parameters
130  *
131  * The new state of the device will be sent off to any subscribers
132  * of device states.  It will also be stored in the internal event
133  * cache.
134  *
135  * \retval 0 on success
136  * \retval -1 on failure
137  */
138 int ast_devstate_changed(enum ast_device_state state, const char *fmt, ...)
139         __attribute__((format(printf, 2, 3)));
140
141 /*!
142  * \brief Tells Asterisk the State for Device is changed
143  *
144  * \param state the new state of the device
145  * \param device device name like a dial string with format parameters
146  *
147  * The new state of the device will be sent off to any subscribers
148  * of device states.  It will also be stored in the internal event
149  * cache.
150  *
151  * \retval 0 on success
152  * \retval -1 on failure
153  */
154 int ast_devstate_changed_literal(enum ast_device_state state, const char *device);
155
156 /*!
157  * \brief Tells Asterisk the State for Device is changed.
158  * (Accept change notification, add it to change queue.)
159  *
160  * \param fmt device name like a dial string with format parameters
161  *
162  * Asterisk polls the new extension states and calls the registered
163  * callbacks for the changed extensions
164  *
165  * \retval 0 on success
166  * \retval -1 on failure
167  *
168  * \note This is deprecated in favor of ast_devstate_changed()
169  * \version 1.6.1 deprecated
170  */
171 int ast_device_state_changed(const char *fmt, ...)
172         __attribute__((deprecated,format(printf, 1, 2)));
173
174 /*!
175  * \brief Tells Asterisk the State for Device is changed
176  *
177  * \param device device name like a dial string
178  *
179  * Asterisk polls the new extension states and calls the registered
180  * callbacks for the changed extensions
181  *
182  * \retval 0 on success
183  * \retval -1 on failure
184  *
185  * \note This is deprecated in favor of ast_devstate_changed_literal()
186  * \version 1.6.1 deprecated
187  */
188 int ast_device_state_changed_literal(const char *device)
189         __attribute__((deprecated));
190
191 /*!
192  * \brief Add device state provider
193  *
194  * \param label to use in hint, like label:object
195  * \param callback Callback
196  *
197  * \retval 0 success
198  * \retval -1 failure
199  */
200 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback);
201
202 /*!
203  * \brief Remove device state provider
204  *
205  * \param label to use in hint, like label:object
206  *
207  * \retval -1 on failure
208  * \retval 0 on success
209  */
210 int ast_devstate_prov_del(const char *label);
211
212 /*!
213  * \brief An object to hold state when calculating aggregate device state
214  */
215 struct ast_devstate_aggregate;
216
217 /*!
218  * \brief Initialize aggregate device state
219  *
220  * \param[in] agg the state object
221  *
222  * \return nothing
223  * \since 1.6.1
224  */
225 void ast_devstate_aggregate_init(struct ast_devstate_aggregate *agg);
226
227 /*!
228  * \brief Add a device state to the aggregate device state
229  *
230  * \param[in] agg the state object
231  * \param[in] state the state to add
232  *
233  * \return nothing
234  * \since 1.6.1
235  */
236 void ast_devstate_aggregate_add(struct ast_devstate_aggregate *agg, enum ast_device_state state);
237
238 /*!
239  * \brief Get the aggregate device state result
240  *
241  * \param[in] agg the state object
242  *
243  * \return the aggregate device state after adding some number of device states.
244  * \since 1.6.1
245  */
246 enum ast_device_state ast_devstate_aggregate_result(struct ast_devstate_aggregate *agg);
247
248 /*!
249  * \brief You shouldn't care about the contents of this struct
250  *
251  * This struct is only here so that it can be easily declared on the stack.
252  */
253 struct ast_devstate_aggregate {
254         unsigned int all_unavail:1;
255         unsigned int all_busy:1;
256         unsigned int all_free:1;
257         unsigned int all_on_hold:1;
258         unsigned int busy:1;
259         unsigned int in_use:1;
260         unsigned int ring:1;
261 };
262
263 #if defined(__cplusplus) || defined(c_plusplus)
264 }
265 #endif
266
267 #endif /* _ASTERISK_DEVICESTATE_H */