Wed Aug 18 22:33:51 2010

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 #include "asterisk/channel.h"
00041 
00042 #if defined(__cplusplus) || defined(c_plusplus)
00043 extern "C" {
00044 #endif
00045 
00046 /*! \brief Device States
00047  *  \note The order of these states may not change because they are included
00048  *        in Asterisk events which may be transmitted across the network to
00049  *        other servers.
00050  */
00051 enum ast_device_state {
00052    AST_DEVICE_UNKNOWN,      /*!< Device is valid but channel didn't know state */
00053    AST_DEVICE_NOT_INUSE,    /*!< Device is not used */
00054    AST_DEVICE_INUSE,        /*!< Device is in use */
00055    AST_DEVICE_BUSY,         /*!< Device is busy */
00056    AST_DEVICE_INVALID,      /*!< Device is invalid */
00057    AST_DEVICE_UNAVAILABLE,  /*!< Device is unavailable */
00058    AST_DEVICE_RINGING,      /*!< Device is ringing */
00059    AST_DEVICE_RINGINUSE,    /*!< Device is ringing *and* in use */
00060    AST_DEVICE_ONHOLD,       /*!< Device is on hold */
00061    AST_DEVICE_TOTAL,        /*/ Total num of device states, used for testing */
00062 };
00063 
00064 /*! \brief Devicestate provider call back */
00065 typedef enum ast_device_state (*ast_devstate_prov_cb_type)(const char *data);
00066 
00067 /*!
00068  * \brief Convert channel state to devicestate
00069  *
00070  * \param chanstate Current channel state
00071  * \since 1.6.1
00072  */
00073 enum ast_device_state ast_state_chan2dev(enum ast_channel_state chanstate);
00074 
00075 /*!
00076  * \brief Convert device state to text string for output
00077  *
00078  * \param devstate Current device state
00079  */
00080 const char *devstate2str(enum ast_device_state devstate);
00081 
00082 /*!
00083  * \brief Convert device state to text string that is easier to parse
00084  *
00085  * \param devstate Current device state
00086  */
00087 const char *ast_devstate_str(enum ast_device_state devstate);
00088 
00089 /*!
00090  * \brief Convert device state from text to integer value
00091  *
00092  * \param val The text representing the device state.  Valid values are anything
00093  *        that comes after AST_DEVICE_ in one of the defined values.
00094  *
00095  * \return The AST_DEVICE_ integer value
00096  */
00097 enum ast_device_state ast_devstate_val(const char *val);
00098 
00099 /*!
00100  * \brief Search the Channels by Name
00101  *
00102  * \param device like a dial string
00103  *
00104  * Search the Device in active channels by compare the channel name against
00105  * the device name. Compared are only the first chars to the first '-' char.
00106  *
00107  * \retval AST_DEVICE_UNKNOWN if no channel found
00108  * \retval AST_DEVICE_INUSE if a channel is found
00109  */
00110 enum ast_device_state ast_parse_device_state(const char *device);
00111 
00112 /*!
00113  * \brief Asks a channel for device state
00114  *
00115  * \param device like a dial string
00116  *
00117  * Asks a channel for device state, data is normally a number from a dial string
00118  * used by the low level module
00119  * Tries the channel device state callback if not supported search in the
00120  * active channels list for the device.
00121  *
00122  * \retval an AST_DEVICE_??? state
00123  * \retval -1 on failure
00124  */
00125 enum ast_device_state ast_device_state(const char *device);
00126 
00127 /*!
00128  * \brief Tells Asterisk the State for Device is changed
00129  *
00130  * \param state the new state of the device
00131  * \param fmt device name like a dial string with format parameters
00132  *
00133  * The new state of the device will be sent off to any subscribers
00134  * of device states.  It will also be stored in the internal event
00135  * cache.
00136  *
00137  * \retval 0 on success
00138  * \retval -1 on failure
00139  */
00140 int ast_devstate_changed(enum ast_device_state state, const char *fmt, ...)
00141    __attribute__((format(printf, 2, 3)));
00142 
00143 /*!
00144  * \brief Tells Asterisk the State for Device is changed
00145  *
00146  * \param state the new state of the device
00147  * \param device device name like a dial string with format parameters
00148  *
00149  * The new state of the device will be sent off to any subscribers
00150  * of device states.  It will also be stored in the internal event
00151  * cache.
00152  *
00153  * \retval 0 on success
00154  * \retval -1 on failure
00155  */
00156 int ast_devstate_changed_literal(enum ast_device_state state, const char *device);
00157 
00158 /*!
00159  * \brief Tells Asterisk the State for Device is changed.
00160  * (Accept change notification, add it to change queue.)
00161  *
00162  * \param fmt device name like a dial string with format parameters
00163  *
00164  * Asterisk polls the new extension states and calls the registered
00165  * callbacks for the changed extensions
00166  *
00167  * \retval 0 on success
00168  * \retval -1 on failure
00169  *
00170  * \note This is deprecated in favor of ast_devstate_changed()
00171  * \version 1.6.1 deprecated
00172  */
00173 int ast_device_state_changed(const char *fmt, ...)
00174    __attribute__((deprecated,format(printf, 1, 2)));
00175 
00176 /*!
00177  * \brief Tells Asterisk the State for Device is changed
00178  *
00179  * \param device device name like a dial string
00180  *
00181  * Asterisk polls the new extension states and calls the registered
00182  * callbacks for the changed extensions
00183  *
00184  * \retval 0 on success
00185  * \retval -1 on failure
00186  *
00187  * \note This is deprecated in favor of ast_devstate_changed_literal()
00188  * \version 1.6.1 deprecated
00189  */
00190 int ast_device_state_changed_literal(const char *device)
00191    __attribute__((deprecated));
00192 
00193 /*!
00194  * \brief Add device state provider
00195  *
00196  * \param label to use in hint, like label:object
00197  * \param callback Callback
00198  *
00199  * \retval 0 success
00200  * \retval -1 failure
00201  */
00202 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback);
00203 
00204 /*!
00205  * \brief Remove device state provider
00206  *
00207  * \param label to use in hint, like label:object
00208  *
00209  * \retval -1 on failure
00210  * \retval 0 on success
00211  */
00212 int ast_devstate_prov_del(const char *label);
00213 
00214 /*!
00215  * \brief An object to hold state when calculating aggregate device state
00216  */
00217 struct ast_devstate_aggregate;
00218 
00219 /*!
00220  * \brief Initialize aggregate device state
00221  *
00222  * \param[in] agg the state object
00223  *
00224  * \return nothing
00225  * \since 1.6.1
00226  */
00227 void ast_devstate_aggregate_init(struct ast_devstate_aggregate *agg);
00228 
00229 /*!
00230  * \brief Add a device state to the aggregate device state
00231  *
00232  * \param[in] agg the state object
00233  * \param[in] state the state to add
00234  *
00235  * \return nothing
00236  * \since 1.6.1
00237  */
00238 void ast_devstate_aggregate_add(struct ast_devstate_aggregate *agg, enum ast_device_state state);
00239 
00240 /*!
00241  * \brief Get the aggregate device state result
00242  *
00243  * \param[in] agg the state object
00244  *
00245  * \return the aggregate device state after adding some number of device states.
00246  * \since 1.6.1
00247  */
00248 enum ast_device_state ast_devstate_aggregate_result(struct ast_devstate_aggregate *agg);
00249 
00250 /*!
00251  * \brief You shouldn't care about the contents of this struct
00252  *
00253  * This struct is only here so that it can be easily declared on the stack.
00254  */
00255 struct ast_devstate_aggregate {
00256    unsigned int all_unknown:1;
00257    unsigned int all_unavail:1;
00258    unsigned int all_busy:1;
00259    unsigned int all_free:1;
00260    unsigned int on_hold:1;
00261    unsigned int busy:1;
00262    unsigned int in_use:1;
00263    unsigned int ring:1;
00264 };
00265 
00266 /*!
00267  * \brief Enable distributed device state processing.
00268  *
00269  * \details
00270  * By default, Asterisk assumes that device state change events will only be
00271  * originating from one instance.  If a module gets loaded and configured such
00272  * that multiple instances of Asterisk will be sharing device state, this
00273  * function should be called to enable distributed device state processing.
00274  * It is off by default to save on unnecessary processing.
00275  *
00276  * \retval 0 success
00277  * \retval -1 failure
00278  */
00279 int ast_enable_distributed_devstate(void);
00280 
00281 #if defined(__cplusplus) || defined(c_plusplus)
00282 }
00283 #endif
00284 
00285 #endif /* _ASTERISK_DEVICESTATE_H */

Generated on Wed Aug 18 22:33:51 2010 for Asterisk - the Open Source PBX by  doxygen 1.4.7