add the new files for the last commit :-)
[asterisk/asterisk.git] / include / asterisk / devicestate.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Device state management
5  * 
6  * Copyright (C) 2005, Digium, Inc.
7  *
8  * This program is free software, distributed under the terms of
9  * the GNU General Public License
10  */
11
12 #ifndef _ASTERISK_DEVICESTATE_H
13 #define _ASTERISK_DEVICESTATE_H
14
15 #if defined(__cplusplus) || defined(c_plusplus)
16 extern "C" {
17 #endif
18
19 /*! Device is valid but channel didn't know state */
20 #define AST_DEVICE_UNKNOWN      0
21 /*! Device is not used */
22 #define AST_DEVICE_NOT_INUSE    1
23 /*! Device is in use */
24 #define AST_DEVICE_INUSE        2
25 /*! Device is busy */
26 #define AST_DEVICE_BUSY         3
27 /*! Device is invalid */
28 #define AST_DEVICE_INVALID      4
29 /*! Device is unavailable */
30 #define AST_DEVICE_UNAVAILABLE  5
31 /*! Device is ringing */
32 #define AST_DEVICE_RINGING      6
33
34 typedef int (*ast_devstate_cb_type)(const char *dev, int state, void *data);
35
36 /*! Search the Channels by Name */
37 /*!
38  * \param device like a dialstring
39  * Search the Device in active channels by compare the channelname against 
40  * the devicename. Compared are only the first chars to the first '-' char.
41  * Returns an AST_DEVICE_UNKNOWN if no channel found or
42  * AST_DEVICE_INUSE if a channel is found
43  */
44 int ast_parse_device_state(const char *device);
45
46 /*! Asks a channel for device state */
47 /*!
48  * \param device like a dialstring
49  * Asks a channel for device state, data is  normaly a number from dialstring
50  * used by the low level module
51  * Trys the channel devicestate callback if not supported search in the
52  * active channels list for the device.
53  * Returns an AST_DEVICE_??? state -1 on failure
54  */
55 int ast_device_state(const char *device);
56
57 /*! Tells Asterisk the State for Device is changed */
58 /*!
59  * \param fmt devicename like a dialstring with format parameters
60  * Asterisk polls the new extensionstates and calls the registered
61  * callbacks for the changed extensions
62  * Returns 0 on success, -1 on failure
63  */
64 int ast_device_state_changed(const char *fmt, ...)
65         __attribute__ ((format (printf, 1, 2)));
66
67 /*! Registers a device state change callback */
68 /*!
69  * \param data to pass to callback
70  * The callback is called if the state for extension is changed
71  * Return -1 on failure, ID on success
72  */ 
73 int ast_devstate_add(ast_devstate_cb_type callback, void *data);
74 void ast_devstate_del(ast_devstate_cb_type callback, void *data);
75
76 int ast_device_state_engine_init(void);
77
78 #if defined(__cplusplus) || defined(c_plusplus)
79 }
80 #endif
81
82 #endif /* _ASTERISK_DEVICESTATE_H */