Wed Jan 27 20:02:10 2016

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

Generated on 27 Jan 2016 for Asterisk - The Open Source Telephony Project by  doxygen 1.6.1