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