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