Merged revisions 76519 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 #if defined(__cplusplus) || defined(c_plusplus)
41 extern "C" {
42 #endif
43
44 /*! 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 /*! \brief Convert device state to text string for output 
65  * \param devstate Current device state 
66  */
67 const char *devstate2str(enum ast_device_state devstate);
68
69 /*! \brief Convert device state to text string that is easier to parse 
70  * \param devstate Current device state 
71  */
72 const char *ast_devstate_str(enum ast_device_state devstate);
73
74 /*! \brief Convert device state from text to integer value
75  * \param val The text representing the device state.  Valid values are anything
76  *        that comes after AST_DEVICE_ in one of the defined values.
77  * \return The AST_DEVICE_ integer value
78  */
79 enum ast_device_state ast_devstate_val(const char *val);
80
81 /*! 
82  * \brief Search the Channels by Name
83  * \param device like a dialstring
84  * Search the Device in active channels by compare the channelname against 
85  * the devicename. Compared are only the first chars to the first '-' char.
86  * \retval an AST_DEVICE_UNKNOWN if no channel found
87  * \retval AST_DEVICE_INUSE if a channel is found
88  */
89 enum ast_device_state ast_parse_device_state(const char *device);
90
91 /*! 
92  * \brief Asks a channel for device state
93  * \param device like a dialstring
94  * Asks a channel for device state, data is  normaly a number from dialstring
95  * used by the low level module
96  * Trys the channel devicestate callback if not supported search in the
97  * active channels list for the device.
98  * \retval an AST_DEVICE_??? state
99  * \retval -1 on failure
100  */
101 enum ast_device_state ast_device_state(const char *device);
102
103 /*! 
104  * \brief Tells Asterisk the State for Device is changed
105  * \param fmt devicename like a dialstring with format parameters
106  * Asterisk polls the new extensionstates and calls the registered
107  * callbacks for the changed extensions
108  * \retval 0 on success
109  * \retval -1 on failure
110  */
111 int ast_device_state_changed(const char *fmt, ...)
112         __attribute__ ((format (printf, 1, 2)));
113
114 /*! 
115  * \brief Tells Asterisk the State for Device is changed 
116  * \param device devicename like a dialstring
117  * Asterisk polls the new extensionstates and calls the registered
118  * callbacks for the changed extensions
119  * \retval 0 on success
120  * \retval -1 on failure
121  */
122 int ast_device_state_changed_literal(const char *device);
123
124 /*! 
125  * \brief Add device state provider 
126  * \param label to use in hint, like label:object
127  * \param callback Callback
128  * \retval 0 success
129  * \retval -1 failure
130  */ 
131 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback);
132
133 /*! 
134  * \brief Remove device state provider 
135  * \param label to use in hint, like label:object
136  * \retval 0 on success
137  * \retval -1 on failure
138  */ 
139 int ast_devstate_prov_del(const char *label);
140
141 #if defined(__cplusplus) || defined(c_plusplus)
142 }
143 #endif
144
145 #endif /* _ASTERISK_DEVICESTATE_H */