3c7f5b40eefae7e6845c08f1f82b3eea39df1b55
[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 typedef int (*ast_devstate_cb_type)(const char *dev, int state, void *data);
48
49 /*! \brief Convert device state to text string for output 
50  * \param devstate Current device state 
51  */
52 const char *devstate2str(int devstate);
53
54 /*! \brief Search the Channels by Name
55  * \param device like a dialstring
56  * Search the Device in active channels by compare the channelname against 
57  * the devicename. Compared are only the first chars to the first '-' char.
58  * Returns an AST_DEVICE_UNKNOWN if no channel found or
59  * AST_DEVICE_INUSE if a channel is found
60  */
61 int ast_parse_device_state(const char *device);
62
63 /*! \brief Asks a channel for device state
64  * \param device like a dialstring
65  * Asks a channel for device state, data is  normaly a number from dialstring
66  * used by the low level module
67  * Trys the channel devicestate callback if not supported search in the
68  * active channels list for the device.
69  * Returns an AST_DEVICE_??? state -1 on failure
70  */
71 int ast_device_state(const char *device);
72
73 /*! \brief Tells Asterisk the State for Device is changed
74  * \param fmt devicename like a dialstring with format parameters
75  * Asterisk polls the new extensionstates and calls the registered
76  * callbacks for the changed extensions
77  * Returns 0 on success, -1 on failure
78  */
79 int ast_device_state_changed(const char *fmt, ...)
80         __attribute__ ((format (printf, 1, 2)));
81
82
83 /*! \brief Tells Asterisk the State for Device is changed 
84  * \param device devicename like a dialstring
85  * Asterisk polls the new extensionstates and calls the registered
86  * callbacks for the changed extensions
87  * Returns 0 on success, -1 on failure
88  */
89 int ast_device_state_changed_literal(const char *device);
90
91 /*! \brief Registers a device state change callback 
92  * \param callback Callback
93  * \param data to pass to callback
94  * The callback is called if the state for extension is changed
95  * Return -1 on failure, ID on success
96  */ 
97 int ast_devstate_add(ast_devstate_cb_type callback, void *data);
98 void ast_devstate_del(ast_devstate_cb_type callback, void *data);
99
100 int ast_device_state_engine_init(void);
101
102 #if defined(__cplusplus) || defined(c_plusplus)
103 }
104 #endif
105
106 #endif /* _ASTERISK_DEVICESTATE_H */