Merge major changes to the way device state is passed around Asterisk. The two
[asterisk/asterisk.git] / include / asterisk / devicestate.h
old mode 100755 (executable)
new mode 100644 (file)
index a2dd6fd..b13547a
@@ -1,12 +1,37 @@
 /*
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
  *
- * Device state management
- * 
- * Copyright (C) 2005, Digium, Inc.
+ * 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
  *
  * This program is free software, distributed under the terms of
- * the GNU General Public License
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ */
+
+/*! \file
+ * \brief Device state management
+ *
+ * To subscribe to device state changes, use the generic ast_event_subscribe
+ * method.  For an example, see apps/app_queue.c.
+ *
+ * \todo Currently, when the state of a device changes, the device state provider
+ * calls one of the functions defined here to queue an object to say that the 
+ * state of a device has changed.  However, this does not include the new state.
+ * Another thread processes these device state change objects and calls the
+ * device state provider's callback to figure out what the new state is.  It
+ * would make a lot more sense for the new state to be included in the original
+ * function call that says the state of a device has changed.  However, it
+ * will take a lot of work to change this.
+ *
+ * \arg See \ref AstExtState
  */
 
 #ifndef _ASTERISK_DEVICESTATE_H
  */
 
 #ifndef _ASTERISK_DEVICESTATE_H
 extern "C" {
 #endif
 
 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
-
-typedef int (*ast_devstate_cb_type)(const char *dev, int state, void *data);
-
-/*! Search the Channels by Name */
-/*!
+/*! Device States 
+ *  \note The order of these states may not change because they are included
+ *        in Asterisk events which may be transmitted across the network to
+ *        other servers.
+ */
+enum ast_device_state {
+       AST_DEVICE_UNKNOWN,      /*!< Device is valid but channel didn't know state */
+       AST_DEVICE_NOT_INUSE,    /*!< Device is not used */
+       AST_DEVICE_INUSE,        /*!< Device is in use */
+       AST_DEVICE_BUSY,         /*!< Device is busy */
+       AST_DEVICE_INVALID,      /*!< Device is invalid */
+       AST_DEVICE_UNAVAILABLE,  /*!< Device is unavailable */
+       AST_DEVICE_RINGING,      /*!< Device is ringing */
+       AST_DEVICE_RINGINUSE,    /*!< Device is ringing *and* in use */
+       AST_DEVICE_ONHOLD,       /*!< Device is on hold */
+};
+
+/*!  \brief Devicestate provider call back */
+typedef enum ast_device_state (*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(enum ast_device_state devstate);
+
+/*! \brief Convert device state to text string that is easier to parse 
+ * \param devstate Current device state 
+ */
+const char *ast_devstate_str(enum ast_device_state devstate);
+
+/*! \brief Convert device state from text to integer value
+ * \param The text representing the device state.  Valid values are anything
+ *        that comes after AST_DEVICE_ in one of the defined values.
+ * \return The AST_DEVICE_ integer value
+ */
+enum ast_device_state ast_devstate_val(const char *val);
+
+/*! \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
  */
  * \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);
+enum ast_device_state ast_parse_device_state(const char *device);
 
 
-/*! Asks a channel for device state */
-/*!
+/*! \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
  * \param device like a dialstring
  * Asks a channel for device state, data is  normaly a number from dialstring
  * used by the low level module
@@ -52,10 +95,9 @@ int ast_parse_device_state(const char *device);
  * active channels list for the device.
  * Returns an AST_DEVICE_??? state -1 on failure
  */
  * active channels list for the device.
  * Returns an AST_DEVICE_??? state -1 on failure
  */
-int ast_device_state(const char *device);
+enum ast_device_state ast_device_state(const char *device);
 
 
-/*! Tells Asterisk the State for Device is changed */
-/*!
+/*! \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
  * \param fmt devicename like a dialstring with format parameters
  * Asterisk polls the new extensionstates and calls the registered
  * callbacks for the changed extensions
@@ -64,16 +106,27 @@ int ast_device_state(const char *device);
 int ast_device_state_changed(const char *fmt, ...)
        __attribute__ ((format (printf, 1, 2)));
 
 int ast_device_state_changed(const char *fmt, ...)
        __attribute__ ((format (printf, 1, 2)));
 
-/*! Registers a device state change 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
+/*! \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 Add device state provider 
+ * \param label to use in hint, like label:object
+ * \param callback Callback
+ * \retval -1 failure
+ * \retval 0 success
  */ 
  */ 
-int ast_devstate_add(ast_devstate_cb_type callback, void *data);
-void ast_devstate_del(ast_devstate_cb_type callback, void *data);
+int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback);
 
 
-int ast_device_state_engine_init(void);
+/*! \brief Remove device state provider 
+ * \param label to use in hint, like label:object
+ * Return -1 on failure, 0 on success
+ */ 
+int ast_devstate_prov_del(const char *label);
 
 #if defined(__cplusplus) || defined(c_plusplus)
 }
 
 #if defined(__cplusplus) || defined(c_plusplus)
 }