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