This introduces a new dialplan function, DEVSTATE, which allows you to do some
[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  * \arg See \ref AstExtState
23  */
24
25 #ifndef _ASTERISK_DEVICESTATE_H
26 #define _ASTERISK_DEVICESTATE_H
27
28 #if defined(__cplusplus) || defined(c_plusplus)
29 extern "C" {
30 #endif
31
32 /*! Device States */
33 enum ast_device_state {
34         AST_DEVICE_UNKNOWN,      /*!< Device is valid but channel didn't know state */
35         AST_DEVICE_NOT_INUSE,    /*!< Device is not used */
36         AST_DEVICE_INUSE,        /*!< Device is in use */
37         AST_DEVICE_BUSY,         /*!< Device is busy */
38         AST_DEVICE_INVALID,      /*!< Device is invalid */
39         AST_DEVICE_UNAVAILABLE,  /*!< Device is unavailable */
40         AST_DEVICE_RINGING,      /*!< Device is ringing */
41         AST_DEVICE_RINGINUSE,    /*!< Device is ringing *and* in use */
42         AST_DEVICE_ONHOLD,       /*!< Device is on hold */
43 };
44
45 /*! \brief Devicestate watcher call back */
46 typedef int (*ast_devstate_cb_type)(const char *dev, enum ast_device_state state, void *data);
47
48 /*!  \brief Devicestate provider call back */
49 typedef enum ast_device_state (*ast_devstate_prov_cb_type)(const char *data);
50
51 /*! \brief Convert device state to text string for output 
52  * \param devstate Current device state 
53  */
54 const char *devstate2str(enum ast_device_state devstate);
55
56 /*! \brief Convert device state to text string that is easier to parse 
57  * \param devstate Current device state 
58  */
59 const char *ast_devstate_str(enum ast_device_state devstate);
60
61 /*! \brief Convert device state from text to integer value
62  * \param The text representing the device state.  Valid values are anything
63  *        that comes after AST_DEVICE_ in one of the defined values.
64  * \return The AST_DEVICE_ integer value
65  */
66 enum ast_device_state ast_devstate_val(const char *val);
67
68 /*! \brief Search the Channels by Name
69  * \param device like a dialstring
70  * Search the Device in active channels by compare the channelname against 
71  * the devicename. Compared are only the first chars to the first '-' char.
72  * Returns an AST_DEVICE_UNKNOWN if no channel found or
73  * AST_DEVICE_INUSE if a channel is found
74  */
75 enum ast_device_state ast_parse_device_state(const char *device);
76
77 /*! \brief Asks a channel for device state
78  * \param device like a dialstring
79  * Asks a channel for device state, data is  normaly a number from dialstring
80  * used by the low level module
81  * Trys the channel devicestate callback if not supported search in the
82  * active channels list for the device.
83  * Returns an AST_DEVICE_??? state -1 on failure
84  */
85 enum ast_device_state ast_device_state(const char *device);
86
87 /*! \brief Tells Asterisk the State for Device is changed
88  * \param fmt devicename like a dialstring with format parameters
89  * Asterisk polls the new extensionstates and calls the registered
90  * callbacks for the changed extensions
91  * Returns 0 on success, -1 on failure
92  */
93 int ast_device_state_changed(const char *fmt, ...)
94         __attribute__ ((format (printf, 1, 2)));
95
96
97 /*! \brief Tells Asterisk the State for Device is changed 
98  * \param device devicename like a dialstring
99  * Asterisk polls the new extensionstates and calls the registered
100  * callbacks for the changed extensions
101  * Returns 0 on success, -1 on failure
102  */
103 int ast_device_state_changed_literal(const char *device);
104
105 /*! \brief Registers a device state change callback 
106  * \param callback Callback
107  * \param data to pass to callback
108  * The callback is called if the state for extension is changed
109  * Return -1 on failure, ID on success
110  */ 
111 int ast_devstate_add(ast_devstate_cb_type callback, void *data);
112
113 /*! \brief Unregisters a device state change callback 
114  * \param callback Callback
115  * \param data to pass to callback
116  * The callback is called if the state for extension is changed
117  * Return -1 on failure, ID on success
118  */ 
119 void ast_devstate_del(ast_devstate_cb_type callback, void *data);
120
121 /*! \brief Add device state provider 
122  * \param label to use in hint, like label:object
123  * \param callback Callback
124  * \retval -1 failure
125  * \retval 0 success
126  */ 
127 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback);
128
129 /*! \brief Remove device state provider 
130  * \param label to use in hint, like label:object
131  * Return -1 on failure, 0 on success
132  */ 
133 int ast_devstate_prov_del(const char *label);
134
135 int ast_device_state_engine_init(void);
136
137 #if defined(__cplusplus) || defined(c_plusplus)
138 }
139 #endif
140
141 #endif /* _ASTERISK_DEVICESTATE_H */