#include "asterisk/channelstate.h"
Go to the source code of this file.
Data Structures | |
struct | ast_devstate_aggregate |
You shouldn't care about the contents of this struct. More... | |
Enumerations | |
enum | ast_device_state { AST_DEVICE_UNKNOWN, AST_DEVICE_NOT_INUSE, AST_DEVICE_INUSE, AST_DEVICE_BUSY, AST_DEVICE_INVALID, AST_DEVICE_UNAVAILABLE, AST_DEVICE_RINGING, AST_DEVICE_RINGINUSE, AST_DEVICE_ONHOLD, AST_DEVICE_TOTAL } |
Device States. More... | |
Functions | |
enum ast_device_state | ast_device_state (const char *device) |
Asks a channel for device state. | |
int | ast_device_state_changed (const char *fmt,...) |
Tells Asterisk the State for Device is changed. (Accept change notification, add it to change queue.). | |
int | ast_device_state_changed_literal (const char *device) |
Tells Asterisk the State for Device is changed. | |
const char * | ast_devstate2str (enum ast_device_state devstate) attribute_pure |
Find devicestate as text message for output. | |
void | ast_devstate_aggregate_add (struct ast_devstate_aggregate *agg, enum ast_device_state state) |
Add a device state to the aggregate device state. | |
void | ast_devstate_aggregate_init (struct ast_devstate_aggregate *agg) |
Initialize aggregate device state. | |
enum ast_device_state | ast_devstate_aggregate_result (struct ast_devstate_aggregate *agg) |
Get the aggregate device state result. | |
int | ast_devstate_changed (enum ast_device_state state, const char *fmt,...) |
Tells Asterisk the State for Device is changed. | |
int | ast_devstate_changed_literal (enum ast_device_state state, const char *device) |
Tells Asterisk the State for Device is changed. | |
int | ast_devstate_prov_add (const char *label, ast_devstate_prov_cb_type callback) |
Add device state provider. | |
int | ast_devstate_prov_del (const char *label) |
Remove device state provider. | |
const char * | ast_devstate_str (enum ast_device_state devstate) attribute_pure |
Convert device state to text string that is easier to parse. | |
enum ast_device_state | ast_devstate_val (const char *val) |
Convert device state from text to integer value. | |
int | ast_enable_distributed_devstate (void) |
Enable distributed device state processing. | |
enum ast_device_state | ast_parse_device_state (const char *device) |
Search the Channels by Name. | |
enum ast_device_state | ast_state_chan2dev (enum ast_channel_state chanstate) |
Convert channel state to devicestate. | |
const char * | devstate2str (enum ast_device_state devstate) attribute_pure |
Convert device state to text string for output. | |
Variables | |
enum ast_device_state(*) | ast_devstate_prov_cb_type (const char *data) |
Devicestate provider call back. |
To subscribe to device state changes, use the generic ast_event_subscribe method. For an example, see apps/app_queue.c.
Definition in file devicestate.h.
enum ast_device_state |
Device States.
Definition at line 51 of file devicestate.h.
00051 { 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 };
enum ast_device_state ast_device_state | ( | const char * | device | ) |
Asks a channel for device state.
device | like a dial string |
an | AST_DEVICE_??? state | |
-1 | on failure |
Definition at line 360 of file devicestate.c.
References _ast_device_state().
Referenced by _ast_device_state(), ast_devstate_aggregate_add(), ast_extension_state3(), ast_parse_device_state(), calendarstate(), cc_generic_agent_recall(), cc_generic_agent_status_request(), cc_generic_monitor_suspend(), cc_generic_monitor_unsuspend(), cc_status_response(), chanavail_exec(), create_new_generic_list(), dahdi_pri_update_span_devstate(), device_state_cb(), devstate_cached(), devstate_read(), devstate_write(), do_state_change(), generic_agent_devstate_cb(), generic_monitor_devstate_tp_cb(), get_queue_member_status(), handle_cli_devstate_change(), process_collection(), sip_cc_agent_status_request(), skinny_extensionstate_cb(), sla_state(), and state_notify_build_xml().
00361 { 00362 /* This function is called from elsewhere in the code to find out the 00363 * current state of a device. Check the cache, first. */ 00364 00365 return _ast_device_state(device, 1); 00366 }
int ast_device_state_changed | ( | const char * | fmt, | |
... | ||||
) |
Tells Asterisk the State for Device is changed. (Accept change notification, add it to change queue.).
fmt | device name like a dial string with format parameters |
0 | on success | |
-1 | on failure |
Definition at line 520 of file devicestate.c.
References AST_DEVICE_UNKNOWN, ast_devstate_changed_literal(), and AST_MAX_EXTENSION.
00521 { 00522 char buf[AST_MAX_EXTENSION]; 00523 va_list ap; 00524 00525 va_start(ap, fmt); 00526 vsnprintf(buf, sizeof(buf), fmt, ap); 00527 va_end(ap); 00528 00529 return ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, buf); 00530 }
int ast_device_state_changed_literal | ( | const char * | device | ) |
Tells Asterisk the State for Device is changed.
device | device name like a dial string |
0 | on success | |
-1 | on failure |
Definition at line 503 of file devicestate.c.
References AST_DEVICE_UNKNOWN, and ast_devstate_changed_literal().
00504 { 00505 return ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, dev); 00506 }
const char* ast_devstate2str | ( | enum ast_device_state | devstate | ) |
Find devicestate as text message for output.
Definition at line 213 of file devicestate.c.
Referenced by __queues_show(), do_state_change(), extension_state_cb(), handle_statechange(), notify_metermaids(), and process_collection().
00214 { 00215 return devstatestring[devstate][0]; 00216 }
void ast_devstate_aggregate_add | ( | struct ast_devstate_aggregate * | agg, | |
enum ast_device_state | state | |||
) |
Add a device state to the aggregate device state.
[in] | agg | the state object |
[in] | state | the state to add |
Definition at line 740 of file devicestate.c.
References AST_DEVICE_BUSY, AST_DEVICE_INUSE, AST_DEVICE_ONHOLD, AST_DEVICE_RINGING, AST_DEVICE_RINGINUSE, ast_device_state(), ast_devstate_aggregate::inuse, ast_devstate_aggregate::ringing, and ast_devstate_aggregate::state.
Referenced by ast_extension_state3(), and process_collection().
00741 { 00742 static enum ast_device_state state_order[] = { 00743 1, /* AST_DEVICE_UNKNOWN */ 00744 3, /* AST_DEVICE_NOT_INUSE */ 00745 6, /* AST_DEVICE_INUSE */ 00746 7, /* AST_DEVICE_BUSY */ 00747 0, /* AST_DEVICE_INVALID */ 00748 2, /* AST_DEVICE_UNAVAILABLE */ 00749 5, /* AST_DEVICE_RINGING */ 00750 8, /* AST_DEVICE_RINGINUSE */ 00751 4, /* AST_DEVICE_ONHOLD */ 00752 }; 00753 00754 if (state == AST_DEVICE_RINGING) { 00755 agg->ringing = 1; 00756 } else if (state == AST_DEVICE_INUSE || state == AST_DEVICE_ONHOLD || state == AST_DEVICE_BUSY) { 00757 agg->inuse = 1; 00758 } 00759 00760 if (agg->ringing && agg->inuse) { 00761 agg->state = AST_DEVICE_RINGINUSE; 00762 } else if (state_order[state] > state_order[agg->state]) { 00763 agg->state = state; 00764 } 00765 }
void ast_devstate_aggregate_init | ( | struct ast_devstate_aggregate * | agg | ) |
Initialize aggregate device state.
[in] | agg | the state object |
Definition at line 734 of file devicestate.c.
References AST_DEVICE_INVALID.
Referenced by ast_extension_state3(), and process_collection().
00735 { 00736 memset(agg, 0, sizeof(*agg)); 00737 agg->state = AST_DEVICE_INVALID; 00738 }
enum ast_device_state ast_devstate_aggregate_result | ( | struct ast_devstate_aggregate * | agg | ) |
Get the aggregate device state result.
[in] | agg | the state object |
Definition at line 767 of file devicestate.c.
References ast_devstate_aggregate::state.
Referenced by ast_extension_state3(), and process_collection().
00768 { 00769 return agg->state; 00770 }
int ast_devstate_changed | ( | enum ast_device_state | state, | |
const char * | fmt, | |||
... | ||||
) |
Tells Asterisk the State for Device is changed.
state | the new state of the device | |
fmt | device name like a dial string with format parameters |
0 | on success | |
-1 | on failure |
Definition at line 508 of file devicestate.c.
References ast_devstate_changed_literal(), and AST_MAX_EXTENSION.
Referenced by __expire_registry(), __iax2_poke_noanswer(), agent_call(), agent_hangup(), agent_read(), calendar_devstate_change(), conf_run(), dahdi_pri_update_span_devstate(), destroy_event(), devstate_write(), expire_register(), handle_cli_devstate_change(), handle_offhook_message(), handle_onhook_message(), handle_response_peerpoke(), handle_soft_key_event_message(), handle_stimulus_message(), join_conference_bridge(), leave_conference_bridge(), load_module(), login_exec(), notify_metermaids(), reg_source_db(), register_verify(), sip_peer_hold(), sip_poke_noanswer(), skinny_register(), skinny_unregister(), sla_change_trunk_state(), sla_handle_hold_event(), sla_station_exec(), socket_process(), update_call_counter(), and update_registry().
00509 { 00510 char buf[AST_MAX_EXTENSION]; 00511 va_list ap; 00512 00513 va_start(ap, fmt); 00514 vsnprintf(buf, sizeof(buf), fmt, ap); 00515 va_end(ap); 00516 00517 return ast_devstate_changed_literal(state, buf); 00518 }
int ast_devstate_changed_literal | ( | enum ast_device_state | state, | |
const char * | device | |||
) |
Tells Asterisk the State for Device is changed.
state | the new state of the device | |
device | device name like a dial string with format parameters |
0 | on success | |
-1 | on failure |
Definition at line 465 of file devicestate.c.
References ast_calloc, ast_cond_signal, AST_DEVICE_UNKNOWN, AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_UNLOCK, change_thread, devstate_event(), do_state_change(), and devstate_prov::list.
Referenced by ast_channel_destructor(), ast_device_state_changed(), ast_device_state_changed_literal(), ast_devstate_changed(), ast_setstate(), and dahdi_new().
00466 { 00467 struct state_change *change; 00468 00469 /* 00470 * If we know the state change (how nice of the caller of this function!) 00471 * then we can just generate a device state event. 00472 * 00473 * Otherwise, we do the following: 00474 * - Queue an event up to another thread that the state has changed 00475 * - In the processing thread, it calls the callback provided by the 00476 * device state provider (which may or may not be a channel driver) 00477 * to determine the state. 00478 * - If the device state provider does not know the state, or this is 00479 * for a channel and the channel driver does not implement a device 00480 * state callback, then we will look through the channel list to 00481 * see if we can determine a state based on active calls. 00482 * - Once a state has been determined, a device state event is generated. 00483 */ 00484 00485 if (state != AST_DEVICE_UNKNOWN) { 00486 devstate_event(device, state); 00487 } else if (change_thread == AST_PTHREADT_NULL || !(change = ast_calloc(1, sizeof(*change) + strlen(device)))) { 00488 /* we could not allocate a change struct, or */ 00489 /* there is no background thread, so process the change now */ 00490 do_state_change(device); 00491 } else { 00492 /* queue the change */ 00493 strcpy(change->device, device); 00494 AST_LIST_LOCK(&state_changes); 00495 AST_LIST_INSERT_TAIL(&state_changes, change, list); 00496 ast_cond_signal(&change_pending); 00497 AST_LIST_UNLOCK(&state_changes); 00498 } 00499 00500 return 1; 00501 }
int ast_devstate_prov_add | ( | const char * | label, | |
ast_devstate_prov_cb_type | callback | |||
) |
Add device state provider.
label | to use in hint, like label:object | |
callback | Callback |
0 | success | |
-1 | failure |
Definition at line 369 of file devicestate.c.
References ast_calloc, ast_copy_string(), AST_RWLIST_INSERT_HEAD, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and devstate_prov::list.
Referenced by ast_features_init(), and load_module().
00370 { 00371 struct devstate_prov *devprov; 00372 00373 if (!callback || !(devprov = ast_calloc(1, sizeof(*devprov)))) 00374 return -1; 00375 00376 devprov->callback = callback; 00377 ast_copy_string(devprov->label, label, sizeof(devprov->label)); 00378 00379 AST_RWLIST_WRLOCK(&devstate_provs); 00380 AST_RWLIST_INSERT_HEAD(&devstate_provs, devprov, list); 00381 AST_RWLIST_UNLOCK(&devstate_provs); 00382 00383 return 0; 00384 }
int ast_devstate_prov_del | ( | const char * | label | ) |
Remove device state provider.
label | to use in hint, like label:object |
-1 | on failure | |
0 | on success |
Definition at line 387 of file devicestate.c.
References ast_free, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, devstate_prov::label, and devstate_prov::list.
Referenced by unload_module().
00388 { 00389 struct devstate_prov *devcb; 00390 int res = -1; 00391 00392 AST_RWLIST_WRLOCK(&devstate_provs); 00393 AST_RWLIST_TRAVERSE_SAFE_BEGIN(&devstate_provs, devcb, list) { 00394 if (!strcasecmp(devcb->label, label)) { 00395 AST_RWLIST_REMOVE_CURRENT(list); 00396 ast_free(devcb); 00397 res = 0; 00398 break; 00399 } 00400 } 00401 AST_RWLIST_TRAVERSE_SAFE_END; 00402 AST_RWLIST_UNLOCK(&devstate_provs); 00403 00404 return res; 00405 }
const char* ast_devstate_str | ( | enum ast_device_state | devstate | ) |
Convert device state to text string that is easier to parse.
devstate | Current device state |
Definition at line 237 of file devicestate.c.
Referenced by aji_devstate_cb(), and devstate_read().
00238 { 00239 return devstatestring[state][1]; 00240 }
enum ast_device_state ast_devstate_val | ( | const char * | val | ) |
Convert device state from text to integer value.
val | The text representing the device state. Valid values are anything that comes after AST_DEVICE_ in one of the defined values. |
Definition at line 242 of file devicestate.c.
References AST_DEVICE_BUSY, AST_DEVICE_INUSE, AST_DEVICE_INVALID, AST_DEVICE_NOT_INUSE, AST_DEVICE_ONHOLD, AST_DEVICE_RINGING, AST_DEVICE_RINGINUSE, AST_DEVICE_UNAVAILABLE, and AST_DEVICE_UNKNOWN.
Referenced by aji_handle_pubsub_event(), custom_devstate_callback(), devstate_write(), handle_cli_devstate_change(), and load_module().
00243 { 00244 if (!strcasecmp(val, "NOT_INUSE")) 00245 return AST_DEVICE_NOT_INUSE; 00246 else if (!strcasecmp(val, "INUSE")) 00247 return AST_DEVICE_INUSE; 00248 else if (!strcasecmp(val, "BUSY")) 00249 return AST_DEVICE_BUSY; 00250 else if (!strcasecmp(val, "INVALID")) 00251 return AST_DEVICE_INVALID; 00252 else if (!strcasecmp(val, "UNAVAILABLE")) 00253 return AST_DEVICE_UNAVAILABLE; 00254 else if (!strcasecmp(val, "RINGING")) 00255 return AST_DEVICE_RINGING; 00256 else if (!strcasecmp(val, "RINGINUSE")) 00257 return AST_DEVICE_RINGINUSE; 00258 else if (!strcasecmp(val, "ONHOLD")) 00259 return AST_DEVICE_ONHOLD; 00260 00261 return AST_DEVICE_UNKNOWN; 00262 }
int ast_enable_distributed_devstate | ( | void | ) |
Enable distributed device state processing.
By default, Asterisk assumes that device state change events will only be originating from one instance. If a module gets loaded and configured such that multiple instances of Asterisk will be sharing device state, this function should be called to enable distributed device state processing. It is off by default to save on unnecessary processing.
0 | success | |
-1 | failure |
Definition at line 772 of file devicestate.c.
References ast_cond_init, AST_EVENT_DEVICE_STATE_CHANGE, AST_EVENT_IE_END, ast_event_subscribe(), ast_log(), ast_mutex_init, ast_pthread_create_background, devstate_change_collector_cb(), devstate_collector, LOG_ERROR, and run_devstate_collector().
Referenced by add_publish_event(), add_subscribe_event(), and aji_init_event_distribution().
00773 { 00774 if (devstate_collector.enabled) { 00775 return 0; 00776 } 00777 00778 devstate_collector.event_sub = ast_event_subscribe(AST_EVENT_DEVICE_STATE_CHANGE, 00779 devstate_change_collector_cb, "devicestate_engine_enable_distributed", NULL, AST_EVENT_IE_END); 00780 00781 if (!devstate_collector.event_sub) { 00782 ast_log(LOG_ERROR, "Failed to create subscription for the device state change collector\n"); 00783 return -1; 00784 } 00785 00786 ast_mutex_init(&devstate_collector.lock); 00787 ast_cond_init(&devstate_collector.cond, NULL); 00788 if (ast_pthread_create_background(&devstate_collector.thread, NULL, run_devstate_collector, NULL) < 0) { 00789 ast_log(LOG_ERROR, "Unable to start device state collector thread.\n"); 00790 return -1; 00791 } 00792 00793 devstate_collector.enabled = 1; 00794 00795 return 0; 00796 }
enum ast_device_state ast_parse_device_state | ( | const char * | device | ) |
Search the Channels by Name.
Definition at line 269 of file devicestate.c.
References ast_channel::_state, ast_channel_get_by_name_prefix(), AST_CHANNEL_NAME, ast_channel_unref, AST_DEVICE_INUSE, AST_DEVICE_RINGING, ast_device_state(), AST_DEVICE_UNKNOWN, AST_STATE_RINGING, and match().
Referenced by _ast_device_state(), and chanavail_exec().
00270 { 00271 struct ast_channel *chan; 00272 char match[AST_CHANNEL_NAME]; 00273 enum ast_device_state res; 00274 00275 snprintf(match, sizeof(match), "%s-", device); 00276 00277 if (!(chan = ast_channel_get_by_name_prefix(match, strlen(match)))) { 00278 return AST_DEVICE_UNKNOWN; 00279 } 00280 00281 res = (chan->_state == AST_STATE_RINGING) ? AST_DEVICE_RINGING : AST_DEVICE_INUSE; 00282 00283 chan = ast_channel_unref(chan); 00284 00285 return res; 00286 }
enum ast_device_state ast_state_chan2dev | ( | enum ast_channel_state | chanstate | ) |
Convert channel state to devicestate.
chanstate | Current channel state |
Definition at line 224 of file devicestate.c.
References AST_DEVICE_UNKNOWN.
00225 { 00226 int i; 00227 chanstate &= 0xFFFF; 00228 for (i = 0; chan2dev[i].chan != -100; i++) { 00229 if (chan2dev[i].chan == chanstate) { 00230 return chan2dev[i].dev; 00231 } 00232 } 00233 return AST_DEVICE_UNKNOWN; 00234 }
const char* devstate2str | ( | enum ast_device_state | devstate | ) |
Convert device state to text string for output.
devstate | Current device state |
Definition at line 219 of file devicestate.c.
00220 { 00221 return devstatestring[devstate][0]; 00222 }
enum ast_device_state(*) ast_devstate_prov_cb_type(const char *data) |