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