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