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