add English device state output (bug #4733, with minor mod)
[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 /*! Convert device state to text string for output */
37 /*! \param devstate Current device state */
38 const char *devstate2str(int devstate);
39
40 /*! Search the Channels by Name */
41 /*!
42  * \param device like a dialstring
43  * Search the Device in active channels by compare the channelname against 
44  * the devicename. Compared are only the first chars to the first '-' char.
45  * Returns an AST_DEVICE_UNKNOWN if no channel found or
46  * AST_DEVICE_INUSE if a channel is found
47  */
48 int ast_parse_device_state(const char *device);
49
50 /*! Asks a channel for device state */
51 /*!
52  * \param device like a dialstring
53  * Asks a channel for device state, data is  normaly a number from dialstring
54  * used by the low level module
55  * Trys the channel devicestate callback if not supported search in the
56  * active channels list for the device.
57  * Returns an AST_DEVICE_??? state -1 on failure
58  */
59 int ast_device_state(const char *device);
60
61 /*! Tells Asterisk the State for Device is changed */
62 /*!
63  * \param fmt devicename like a dialstring with format parameters
64  * Asterisk polls the new extensionstates and calls the registered
65  * callbacks for the changed extensions
66  * Returns 0 on success, -1 on failure
67  */
68 int ast_device_state_changed(const char *fmt, ...)
69         __attribute__ ((format (printf, 1, 2)));
70
71 /*! Registers a device state change callback */
72 /*!
73  * \param data to pass to callback
74  * The callback is called if the state for extension is changed
75  * Return -1 on failure, ID on success
76  */ 
77 int ast_devstate_add(ast_devstate_cb_type callback, void *data);
78 void ast_devstate_del(ast_devstate_cb_type callback, void *data);
79
80 int ast_device_state_engine_init(void);
81
82 #if defined(__cplusplus) || defined(c_plusplus)
83 }
84 #endif
85
86 #endif /* _ASTERISK_DEVICESTATE_H */