mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-24 06:53:41 +00:00
4c90cf59b7
and implement holding in the SLA. git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@37318 65c4cc65-6c06-0410-ace0-fbb531ad65f3
133 lines
4.2 KiB
C
133 lines
4.2 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 1999 - 2005, Digium, Inc.
|
|
*
|
|
* Mark Spencer <markster@digium.com>
|
|
*
|
|
* See http://www.asterisk.org for more information about
|
|
* the Asterisk project. Please do not directly contact
|
|
* any of the maintainers of this project for assistance;
|
|
* the project provides a web site, mailing lists and IRC
|
|
* channels for your use.
|
|
*
|
|
* This program is free software, distributed under the terms of
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
*/
|
|
|
|
/*! \file
|
|
* \brief Device state management
|
|
*/
|
|
|
|
#ifndef _ASTERISK_DEVICESTATE_H
|
|
#define _ASTERISK_DEVICESTATE_H
|
|
|
|
#if defined(__cplusplus) || defined(c_plusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*! Device is valid but channel didn't know state */
|
|
#define AST_DEVICE_UNKNOWN 0
|
|
/*! Device is not used */
|
|
#define AST_DEVICE_NOT_INUSE 1
|
|
/*! Device is in use */
|
|
#define AST_DEVICE_INUSE 2
|
|
/*! Device is busy */
|
|
#define AST_DEVICE_BUSY 3
|
|
/*! Device is invalid */
|
|
#define AST_DEVICE_INVALID 4
|
|
/*! Device is unavailable */
|
|
#define AST_DEVICE_UNAVAILABLE 5
|
|
/*! Device is ringing */
|
|
#define AST_DEVICE_RINGING 6
|
|
/*! Device is ringing *and* in use */
|
|
#define AST_DEVICE_RINGINUSE 7
|
|
/*! Device is on hold */
|
|
#define AST_DEVICE_ONHOLD 8
|
|
|
|
/*! \brief Devicestate watcher call back */
|
|
typedef int (*ast_devstate_cb_type)(const char *dev, int state, void *data);
|
|
|
|
/*! \brief Devicestate provider call back */
|
|
typedef int (*ast_devstate_prov_cb_type)(const char *data);
|
|
|
|
/*! \brief Convert device state to text string for output
|
|
* \param devstate Current device state
|
|
*/
|
|
const char *devstate2str(int devstate);
|
|
|
|
/*! \brief Search the Channels by Name
|
|
* \param device like a dialstring
|
|
* Search the Device in active channels by compare the channelname against
|
|
* the devicename. Compared are only the first chars to the first '-' char.
|
|
* Returns an AST_DEVICE_UNKNOWN if no channel found or
|
|
* AST_DEVICE_INUSE if a channel is found
|
|
*/
|
|
int ast_parse_device_state(const char *device);
|
|
|
|
/*! \brief Asks a channel for device state
|
|
* \param device like a dialstring
|
|
* Asks a channel for device state, data is normaly a number from dialstring
|
|
* used by the low level module
|
|
* Trys the channel devicestate callback if not supported search in the
|
|
* active channels list for the device.
|
|
* Returns an AST_DEVICE_??? state -1 on failure
|
|
*/
|
|
int ast_device_state(const char *device);
|
|
|
|
/*! \brief Tells Asterisk the State for Device is changed
|
|
* \param fmt devicename like a dialstring with format parameters
|
|
* Asterisk polls the new extensionstates and calls the registered
|
|
* callbacks for the changed extensions
|
|
* Returns 0 on success, -1 on failure
|
|
*/
|
|
int ast_device_state_changed(const char *fmt, ...)
|
|
__attribute__ ((format (printf, 1, 2)));
|
|
|
|
|
|
/*! \brief Tells Asterisk the State for Device is changed
|
|
* \param device devicename like a dialstring
|
|
* Asterisk polls the new extensionstates and calls the registered
|
|
* callbacks for the changed extensions
|
|
* Returns 0 on success, -1 on failure
|
|
*/
|
|
int ast_device_state_changed_literal(const char *device);
|
|
|
|
/*! \brief Registers a device state change callback
|
|
* \param callback Callback
|
|
* \param data to pass to callback
|
|
* The callback is called if the state for extension is changed
|
|
* Return -1 on failure, ID on success
|
|
*/
|
|
int ast_devstate_add(ast_devstate_cb_type callback, void *data);
|
|
|
|
/*! \brief Unregisters a device state change callback
|
|
* \param callback Callback
|
|
* \param data to pass to callback
|
|
* The callback is called if the state for extension is changed
|
|
* Return -1 on failure, ID on success
|
|
*/
|
|
void ast_devstate_del(ast_devstate_cb_type callback, void *data);
|
|
|
|
/*! \brief Add device state provider
|
|
* \param label to use in hint, like label:object
|
|
* \param callback Callback
|
|
* Return -1 on failure, ID on success
|
|
*/
|
|
int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback);
|
|
|
|
/*! \brief Remove device state provider
|
|
* \param label to use in hint, like label:object
|
|
* Return -1 on failure, ID on success
|
|
*/
|
|
void ast_devstate_prov_del(const char *label);
|
|
|
|
int ast_device_state_engine_init(void);
|
|
|
|
#if defined(__cplusplus) || defined(c_plusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* _ASTERISK_DEVICESTATE_H */
|