687e6819f9dc1e7b2b18d2c43e72b7714c16652b
[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 /*
20  * 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
45 typedef int (*ast_devstate_cb_type)(const char *dev, int state, void *data);
46
47 /*! Convert device state to text string for output */
48 /*! \param devstate Current device state */
49 const char *devstate2str(int devstate);
50
51 /*! Search the Channels by Name */
52 /*!
53  * \param device like a dialstring
54  * Search the Device in active channels by compare the channelname against 
55  * the devicename. Compared are only the first chars to the first '-' char.
56  * Returns an AST_DEVICE_UNKNOWN if no channel found or
57  * AST_DEVICE_INUSE if a channel is found
58  */
59 int ast_parse_device_state(const char *device);
60
61 /*! Asks a channel for device state */
62 /*!
63  * \param device like a dialstring
64  * Asks a channel for device state, data is  normaly a number from dialstring
65  * used by the low level module
66  * Trys the channel devicestate callback if not supported search in the
67  * active channels list for the device.
68  * Returns an AST_DEVICE_??? state -1 on failure
69  */
70 int ast_device_state(const char *device);
71
72 /*! Tells Asterisk the State for Device is changed */
73 /*!
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 /*! Registers a device state change callback */
83 /*!
84  * \param data to pass to callback
85  * The callback is called if the state for extension is changed
86  * Return -1 on failure, ID on success
87  */ 
88 int ast_devstate_add(ast_devstate_cb_type callback, void *data);
89 void ast_devstate_del(ast_devstate_cb_type callback, void *data);
90
91 int ast_device_state_engine_init(void);
92
93 #if defined(__cplusplus) || defined(c_plusplus)
94 }
95 #endif
96
97 #endif /* _ASTERISK_DEVICESTATE_H */