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