Wed Oct 28 11:45:37 2009

Asterisk developer's documentation


devicestate.h

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 1999 - 2005, Digium, Inc.
00005  *
00006  * Mark Spencer <markster@digium.com>
00007  *
00008  * See http://www.asterisk.org for more information about
00009  * the Asterisk project. Please do not directly contact
00010  * any of the maintainers of this project for assistance;
00011  * the project provides a web site, mailing lists and IRC
00012  * channels for your use.
00013  *
00014  * This program is free software, distributed under the terms of
00015  * the GNU General Public License Version 2. See the LICENSE file
00016  * at the top of the source tree.
00017  */
00018 
00019 /*! \file
00020  * \brief Device state management
00021  *
00022  * To subscribe to device state changes, use the generic ast_event_subscribe
00023  * method.  For an example, see apps/app_queue.c.
00024  *
00025  * \todo Currently, when the state of a device changes, the device state provider
00026  * calls one of the functions defined here to queue an object to say that the 
00027  * state of a device has changed.  However, this does not include the new state.
00028  * Another thread processes these device state change objects and calls the
00029  * device state provider's callback to figure out what the new state is.  It
00030  * would make a lot more sense for the new state to be included in the original
00031  * function call that says the state of a device has changed.  However, it
00032  * will take a lot of work to change this.
00033  *
00034  * \arg See \ref AstExtState
00035  */
00036 
00037 #ifndef _ASTERISK_DEVICESTATE_H
00038 #define _ASTERISK_DEVICESTATE_H
00039 
00040 #if defined(__cplusplus) || defined(c_plusplus)
00041 extern "C" {
00042 #endif
00043 
00044 /*! \brief Device States 
00045  *  \note The order of these states may not change because they are included
00046  *        in Asterisk events which may be transmitted across the network to
00047  *        other servers.
00048  */
00049 enum ast_device_state {
00050    AST_DEVICE_UNKNOWN,      /*!< Device is valid but channel didn't know state */
00051    AST_DEVICE_NOT_INUSE,    /*!< Device is not used */
00052    AST_DEVICE_INUSE,        /*!< Device is in use */
00053    AST_DEVICE_BUSY,         /*!< Device is busy */
00054    AST_DEVICE_INVALID,      /*!< Device is invalid */
00055    AST_DEVICE_UNAVAILABLE,  /*!< Device is unavailable */
00056    AST_DEVICE_RINGING,      /*!< Device is ringing */
00057    AST_DEVICE_RINGINUSE,    /*!< Device is ringing *and* in use */
00058    AST_DEVICE_ONHOLD,       /*!< Device is on hold */
00059    AST_DEVICE_TOTAL,        /*/ Total num of device states, used for testing */
00060 };
00061 
00062 /*! \brief Devicestate provider call back */
00063 typedef enum ast_device_state (*ast_devstate_prov_cb_type)(const char *data);
00064 
00065 /*! 
00066  * \brief Convert device state to text string for output 
00067  *
00068  * \param devstate Current device state 
00069  */
00070 const char *devstate2str(enum ast_device_state devstate);
00071 
00072 /*! 
00073  * \brief Convert device state to text string that is easier to parse 
00074  *
00075  * \param devstate Current device state 
00076  */
00077 const char *ast_devstate_str(enum ast_device_state devstate);
00078 
00079 /*! 
00080  * \brief Convert device state from text to integer value
00081  *
00082  * \param val The text representing the device state.  Valid values are anything
00083  *        that comes after AST_DEVICE_ in one of the defined values.
00084  *
00085  * \return The AST_DEVICE_ integer value
00086  */
00087 enum ast_device_state ast_devstate_val(const char *val);
00088 
00089 /*! 
00090  * \brief Search the Channels by Name
00091  *
00092  * \param device like a dial string
00093  *
00094  * Search the Device in active channels by compare the channel name against 
00095  * the device name. Compared are only the first chars to the first '-' char.
00096  *
00097  * \retval AST_DEVICE_UNKNOWN if no channel found
00098  * \retval AST_DEVICE_INUSE if a channel is found
00099  */
00100 enum ast_device_state ast_parse_device_state(const char *device);
00101 
00102 /*! 
00103  * \brief Asks a channel for device state
00104  *
00105  * \param device like a dial string
00106  *
00107  * Asks a channel for device state, data is normally a number from a dial string
00108  * used by the low level module
00109  * Tries the channel device state callback if not supported search in the
00110  * active channels list for the device.
00111  *
00112  * \retval an AST_DEVICE_??? state 
00113  * \retval -1 on failure
00114  */
00115 enum ast_device_state ast_device_state(const char *device);
00116 
00117 /*! 
00118  * \brief Tells Asterisk the State for Device is changed
00119  *
00120  * \param state the new state of the device
00121  * \param fmt device name like a dial string with format parameters
00122  *
00123  * The new state of the device will be sent off to any subscribers
00124  * of device states.  It will also be stored in the internal event
00125  * cache.
00126  *
00127  * \retval 0 on success 
00128  * \retval -1 on failure
00129  */
00130 int ast_devstate_changed(enum ast_device_state state, const char *fmt, ...)
00131    __attribute__((format(printf, 2, 3)));
00132 
00133 /*! 
00134  * \brief Tells Asterisk the State for Device is changed
00135  *
00136  * \param state the new state of the device
00137  * \param device device name like a dial string with format parameters
00138  *
00139  * The new state of the device will be sent off to any subscribers
00140  * of device states.  It will also be stored in the internal event
00141  * cache.
00142  *
00143  * \retval 0 on success 
00144  * \retval -1 on failure
00145  */
00146 int ast_devstate_changed_literal(enum ast_device_state state, const char *device);
00147 
00148 /*! 
00149  * \brief Tells Asterisk the State for Device is changed
00150  *
00151  * \param fmt device name like a dial string with format parameters
00152  *
00153  * Asterisk polls the new extension states and calls the registered
00154  * callbacks for the changed extensions
00155  *
00156  * \retval 0 on success 
00157  * \retval -1 on failure
00158  *
00159  * \note This is deprecated in favor of ast_devstate_changed()
00160  */
00161 int ast_device_state_changed(const char *fmt, ...)
00162    __attribute__((format(printf, 1, 2)));
00163 
00164 /*! 
00165  * \brief Tells Asterisk the State for Device is changed 
00166  *
00167  * \param device device name like a dial string
00168  *
00169  * Asterisk polls the new extension states and calls the registered
00170  * callbacks for the changed extensions
00171  *
00172  * \retval 0 on success 
00173  * \retval -1 on failure
00174  *
00175  * \note This is deprecated in favor of ast_devstate_changed_literal()
00176  */
00177 int ast_device_state_changed_literal(const char *device);
00178 
00179 /*!
00180  * \brief An object to hold state when calculating aggregate device state
00181  */
00182 struct ast_devstate_aggregate;
00183 
00184 /*!
00185  * \brief Initialize aggregate device state
00186  *
00187  * \param[in] agg the state object
00188  *
00189  * \return nothing
00190  */
00191 void ast_devstate_aggregate_init(struct ast_devstate_aggregate *agg);
00192 
00193 /*!
00194  * \brief Add a device state to the aggregate device state
00195  *
00196  * \param[in] agg the state object
00197  * \param[in] state the state to add
00198  *
00199  * \return nothing
00200  */
00201 void ast_devstate_aggregate_add(struct ast_devstate_aggregate *agg, enum ast_device_state state);
00202 
00203 /*!
00204  * \brief Get the aggregate device state result
00205  *
00206  * \param[in] agg the state object
00207  *
00208  * \return the aggregate device state after adding some number of device states.
00209  */
00210 enum ast_device_state ast_devstate_aggregate_result(struct ast_devstate_aggregate *agg);
00211 
00212 /*!
00213  * \brief You shouldn't care about the contents of this struct
00214  *
00215  * This struct is only here so that it can be easily declared on the stack.
00216  */
00217 struct ast_devstate_aggregate {
00218    unsigned int all_unavail:1;
00219    unsigned int all_busy:1;
00220    unsigned int all_free:1;
00221    unsigned int all_unknown:1;
00222    unsigned int on_hold:1;
00223    unsigned int busy:1;
00224    unsigned int in_use:1;
00225    unsigned int ring:1;
00226 };
00227 
00228 /*! 
00229  * \brief Add device state provider 
00230  *
00231  * \param label to use in hint, like label:object
00232  * \param callback Callback
00233  *
00234  * \retval 0 success
00235  * \retval -1 failure
00236  */ 
00237 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback);
00238 
00239 /*! 
00240  * \brief Remove device state provider 
00241  *
00242  * \param label to use in hint, like label:object
00243  *
00244  * \retval -1 on failure 
00245  * \retval 0 on success
00246  */ 
00247 int ast_devstate_prov_del(const char *label);
00248 
00249 #if defined(__cplusplus) || defined(c_plusplus)
00250 }
00251 #endif
00252 
00253 #endif /* _ASTERISK_DEVICESTATE_H */

Generated on Wed Oct 28 11:45:37 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6