devicestate.h File Reference

Device state management. More...

#include "asterisk/channelstate.h"

Include dependency graph for devicestate.h:

This graph shows which files directly or indirectly include this file:

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...
Typedefs
typedef enum ast_device_state(*	ast_devstate_prov_cb_type )(const char *data)
	Devicestate provider call back.
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...
enum	ast_devstate_cache { AST_DEVSTATE_NOT_CACHABLE, AST_DEVSTATE_CACHABLE }
	Device State Cachability. 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, enum ast_devstate_cache cachable, const char *fmt,...)
	Tells Asterisk the State for Device is changed.
int	ast_devstate_changed_literal (enum ast_device_state state, enum ast_devstate_cache cachable, 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.

---

Detailed Description

Device state management.

To subscribe to device state changes, use the generic ast_event_subscribe method. For an example, see apps/app_queue.c.

Todo:

Currently, when the state of a device changes, the device state provider calls one of the functions defined here to queue an object to say that the state of a device has changed. However, this does not include the new state. Another thread processes these device state change objects and calls the device state provider's callback to figure out what the new state is. It would make a lot more sense for the new state to be included in the original function call that says the state of a device has changed. However, it will take a lot of work to change this.

• See Extension and device states in Asterisk

Definition in file devicestate.h.

---

Typedef Documentation

typedef enum ast_device_state(* ast_devstate_prov_cb_type)(const char *data)

Devicestate provider call back.

Definition at line 73 of file devicestate.h.

---

Enumeration Type Documentation

enum ast_device_state

Device States.

Note:

The order of these states may not change because they are included in Asterisk events which may be transmitted across the network to other servers.

Enumerator:

AST_DEVICE_UNKNOWN	Device is valid but channel didn't know state
AST_DEVICE_NOT_INUSE	Device is not used
AST_DEVICE_INUSE	Device is in use
AST_DEVICE_BUSY	Device is busy
AST_DEVICE_INVALID	Device is invalid
AST_DEVICE_UNAVAILABLE	Device is unavailable
AST_DEVICE_RINGING	Device is ringing
AST_DEVICE_RINGINUSE	Device is ringing *and* in use
AST_DEVICE_ONHOLD	Device is on hold
AST_DEVICE_TOTAL

Definition at line 51 of file devicestate.h.

                      {
   AST_DEVICE_UNKNOWN,      /*!< Device is valid but channel didn't know state */
   AST_DEVICE_NOT_INUSE,    /*!< Device is not used */
   AST_DEVICE_INUSE,        /*!< Device is in use */
   AST_DEVICE_BUSY,         /*!< Device is busy */
   AST_DEVICE_INVALID,      /*!< Device is invalid */
   AST_DEVICE_UNAVAILABLE,  /*!< Device is unavailable */
   AST_DEVICE_RINGING,      /*!< Device is ringing */
   AST_DEVICE_RINGINUSE,    /*!< Device is ringing *and* in use */
   AST_DEVICE_ONHOLD,       /*!< Device is on hold */
   AST_DEVICE_TOTAL,        /*/ Total num of device states, used for testing */
};

enum ast_devstate_cache

Device State Cachability.

Note:

This is used to define the cachability of a device state when set.

Enumerator:

AST_DEVSTATE_NOT_CACHABLE	This device state is not cachable
AST_DEVSTATE_CACHABLE	This device state is cachable

Definition at line 67 of file devicestate.h.

                        {
   AST_DEVSTATE_NOT_CACHABLE,  /*!< This device state is not cachable */
   AST_DEVSTATE_CACHABLE,      /*!< This device state is cachable */
};

---

Function Documentation

enum ast_device_state ast_device_state

(

const char *

device

)

Asks a channel for device state.

Parameters:

device

like a dial string

Asks a channel for device state, data is normally a number from a dial string used by the low level module Tries the channel device state callback if not supported search in the active channels list for the device.

Return values:

an	AST_DEVICE_??? state

Definition at line 362 of file devicestate.c.

References _ast_device_state().

{
   /* This function is called from elsewhere in the code to find out the
    * current state of a device.  Check the cache, first. */

   return _ast_device_state(device, 1);
}

int ast_device_state_changed	(	const char *	fmt,
			...
	)

Tells Asterisk the State for Device is changed. (Accept change notification, add it to change queue.)

Parameters:

fmt	device name like a dial string with format parameters

Asterisk polls the new extension states and calls the registered callbacks for the changed extensions

Return values:

0	on success
-1	on failure

Note:

This is deprecated in favor of ast_devstate_changed()

Version:

1.6.1 deprecated

Definition at line 528 of file devicestate.c.

References AST_DEVICE_UNKNOWN, AST_DEVSTATE_CACHABLE, ast_devstate_changed_literal(), and AST_MAX_EXTENSION.

{
   char buf[AST_MAX_EXTENSION];
   va_list ap;

   va_start(ap, fmt);
   vsnprintf(buf, sizeof(buf), fmt, ap);
   va_end(ap);

   return ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, AST_DEVSTATE_CACHABLE, buf);
}

int ast_device_state_changed_literal

(

const char *

device

)

Tells Asterisk the State for Device is changed.

Parameters:

device

device name like a dial string

Asterisk polls the new extension states and calls the registered callbacks for the changed extensions

Return values:

0	on success
-1	on failure

Note:

This is deprecated in favor of ast_devstate_changed_literal()

Version:

1.6.1 deprecated

Definition at line 511 of file devicestate.c.

References AST_DEVICE_UNKNOWN, AST_DEVSTATE_CACHABLE, and ast_devstate_changed_literal().

{
   return ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, AST_DEVSTATE_CACHABLE, dev);
}

const char* ast_devstate2str

(

enum ast_device_state

devstate

)

Find devicestate as text message for output.

Definition at line 215 of file devicestate.c.

Referenced by __queues_show(), ccss_notify_device_state_change(), do_state_change(), extension_state_cb(), handle_statechange(), notify_metermaids(), page_exec(), and process_collection().

{
   return devstatestring[devstate][0];
}

void ast_devstate_aggregate_add	(	struct ast_devstate_aggregate *	agg,
		enum ast_device_state	state
	)

Add a device state to the aggregate device state.

Parameters:

[in]	agg	the state object
[in]	state	the state to add

Returns:

nothing

Since:

1.6.1

Definition at line 764 of file devicestate.c.

References AST_DEVICE_BUSY, AST_DEVICE_INUSE, AST_DEVICE_ONHOLD, AST_DEVICE_RINGING, AST_DEVICE_RINGINUSE, ast_devstate_aggregate::inuse, ast_devstate_aggregate::ringing, ast_devstate_aggregate::state, and state.

Referenced by ast_extension_state3(), and process_collection().

{
   static enum ast_device_state state_order[] = {
      1, /* AST_DEVICE_UNKNOWN */
      3, /* AST_DEVICE_NOT_INUSE */
      6, /* AST_DEVICE_INUSE */
      7, /* AST_DEVICE_BUSY */
      0, /* AST_DEVICE_INVALID */
      2, /* AST_DEVICE_UNAVAILABLE */
      5, /* AST_DEVICE_RINGING */
      8, /* AST_DEVICE_RINGINUSE */
      4, /* AST_DEVICE_ONHOLD */
   };

   if (state == AST_DEVICE_RINGING) {
      agg->ringing = 1;
   } else if (state == AST_DEVICE_INUSE || state == AST_DEVICE_ONHOLD || state == AST_DEVICE_BUSY) {
      agg->inuse = 1;
   }

   if (agg->ringing && agg->inuse) {
      agg->state = AST_DEVICE_RINGINUSE;
   } else if (state_order[state] > state_order[agg->state]) {
      agg->state = state;
   }
}

void ast_devstate_aggregate_init

(

struct ast_devstate_aggregate *

agg

)

Initialize aggregate device state.

Parameters:

[in]

agg

the state object

Returns:

nothing

Since:

1.6.1

Definition at line 758 of file devicestate.c.

References AST_DEVICE_INVALID, and ast_devstate_aggregate::state.

Referenced by ast_extension_state3(), and process_collection().

{
   memset(agg, 0, sizeof(*agg));
   agg->state = AST_DEVICE_INVALID;
}

enum ast_device_state ast_devstate_aggregate_result

(

struct ast_devstate_aggregate *

agg

)

Get the aggregate device state result.

Parameters:

[in]

agg

the state object

Returns:

the aggregate device state after adding some number of device states.

Since:

1.6.1

Definition at line 791 of file devicestate.c.

References ast_devstate_aggregate::state.

Referenced by ast_extension_state3(), and process_collection().

{
   return agg->state;
}

int ast_devstate_changed	(	enum ast_device_state	state,
		enum ast_devstate_cache	cachable,
		const char *	fmt,
			...
	)

Tells Asterisk the State for Device is changed.

Parameters:

state	the new state of the device
cachable	whether this device state is cachable
fmt	device name like a dial string with format parameters

The new state of the device will be sent off to any subscribers of device states. It will also be stored in the internal event cache.

Return values:

0	on success
-1	on failure

Definition at line 516 of file devicestate.c.

References ast_devstate_changed_literal(), and AST_MAX_EXTENSION.

Referenced by __expire_registry(), __iax2_poke_noanswer(), add_to_queue(), calendar_devstate_change(), ccss_notify_device_state_change(), conf_handle_first_join(), 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_statechange(), handle_stimulus_message(), init_queue(), join_queue(), leave_queue(), load_module(), login_exec(), notify_metermaids(), reg_source_db(), register_verify(), remove_from_queue(), set_member_paused(), sip_peer_hold(), sip_poke_noanswer(), skinny_register(), skinny_unregister(), sla_change_trunk_state(), sla_handle_hold_event(), sla_station_exec(), socket_process_helper(), update_call_counter(), and update_registry().

{
   char buf[AST_MAX_EXTENSION];
   va_list ap;

   va_start(ap, fmt);
   vsnprintf(buf, sizeof(buf), fmt, ap);
   va_end(ap);

   return ast_devstate_changed_literal(state, cachable, buf);
}

int ast_devstate_changed_literal	(	enum ast_device_state	state,
		enum ast_devstate_cache	cachable,
		const char *	device
	)

Tells Asterisk the State for Device is changed.

Parameters:

state	the new state of the device
cachable	whether this device state is cachable
device	device name like a dial string with format parameters

The new state of the device will be sent off to any subscribers of device states. It will also be stored in the internal event cache.

Return values:

0	on success
-1	on failure

Definition at line 472 of file devicestate.c.

References ast_calloc, ast_cond_signal, AST_DEVICE_UNKNOWN, AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_UNLOCK, state_change::cachable, change_thread, state_change::device, devstate_event(), and do_state_change().

Referenced by ast_channel_destructor(), ast_device_state_changed(), ast_device_state_changed_literal(), ast_devstate_changed(), ast_setstate(), and dahdi_new().

{
   struct state_change *change;

   /*
    * If we know the state change (how nice of the caller of this function!)
    * then we can just generate a device state event.
    *
    * Otherwise, we do the following:
    *   - Queue an event up to another thread that the state has changed
    *   - In the processing thread, it calls the callback provided by the
    *     device state provider (which may or may not be a channel driver)
    *     to determine the state.
    *   - If the device state provider does not know the state, or this is
    *     for a channel and the channel driver does not implement a device
    *     state callback, then we will look through the channel list to
    *     see if we can determine a state based on active calls.
    *   - Once a state has been determined, a device state event is generated.
    */

   if (state != AST_DEVICE_UNKNOWN) {
      devstate_event(device, state, cachable);
   } else if (change_thread == AST_PTHREADT_NULL || !(change = ast_calloc(1, sizeof(*change) + strlen(device)))) {
      /* we could not allocate a change struct, or */
      /* there is no background thread, so process the change now */
      do_state_change(device, cachable);
   } else {
      /* queue the change */
      strcpy(change->device, device);
      change->cachable = cachable;
      AST_LIST_LOCK(&state_changes);
      AST_LIST_INSERT_TAIL(&state_changes, change, list);
      ast_cond_signal(&change_pending);
      AST_LIST_UNLOCK(&state_changes);
   }

   return 0;
}

int ast_devstate_prov_add	(	const char *	label,
		ast_devstate_prov_cb_type	callback
	)

Add device state provider.

Parameters:

label	to use in hint, like label:object
callback	Callback

Return values:

0	success
-1	failure

Definition at line 371 of file devicestate.c.

References ast_calloc, ast_copy_string(), AST_RWLIST_INSERT_HEAD, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, devstate_prov::callback, and devstate_prov::label.

Referenced by ast_cc_init(), ast_features_init(), and load_module().

{
   struct devstate_prov *devprov;

   if (!callback || !(devprov = ast_calloc(1, sizeof(*devprov))))
      return -1;

   devprov->callback = callback;
   ast_copy_string(devprov->label, label, sizeof(devprov->label));

   AST_RWLIST_WRLOCK(&devstate_provs);
   AST_RWLIST_INSERT_HEAD(&devstate_provs, devprov, list);
   AST_RWLIST_UNLOCK(&devstate_provs);

   return 0;
}

int ast_devstate_prov_del

(

const char *

label

)

Remove device state provider.

Parameters:

label

to use in hint, like label:object

Return values:

-1	on failure
0	on success

Definition at line 389 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, and devstate_prov::label.

Referenced by cc_shutdown(), features_shutdown(), and unload_module().

{
   struct devstate_prov *devcb;
   int res = -1;

   AST_RWLIST_WRLOCK(&devstate_provs);
   AST_RWLIST_TRAVERSE_SAFE_BEGIN(&devstate_provs, devcb, list) {
      if (!strcasecmp(devcb->label, label)) {
         AST_RWLIST_REMOVE_CURRENT(list);
         ast_free(devcb);
         res = 0;
         break;
      }
   }
   AST_RWLIST_TRAVERSE_SAFE_END;
   AST_RWLIST_UNLOCK(&devstate_provs);

   return res;
}

const char* ast_devstate_str

(

enum ast_device_state

devstate

)

Convert device state to text string that is easier to parse.

Parameters:

devstate

Current device state

Definition at line 239 of file devicestate.c.

References state.

Referenced by aji_devstate_cb(), devstate_read(), and xmpp_pubsub_devstate_cb().

{
   return devstatestring[state][1];
}

enum ast_device_state ast_devstate_val

(

const char *

val

)

Convert device state from text to integer value.

Parameters:

val	The text representing the device state. Valid values are anything that comes after AST_DEVICE_ in one of the defined values.

Returns:

The AST_DEVICE_ integer value

Definition at line 244 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(), initialize_cc_devstate_map_helper(), load_module(), and xmpp_pubsub_handle_event().

{
   if (!strcasecmp(val, "NOT_INUSE"))
      return AST_DEVICE_NOT_INUSE;
   else if (!strcasecmp(val, "INUSE"))
      return AST_DEVICE_INUSE;
   else if (!strcasecmp(val, "BUSY"))
      return AST_DEVICE_BUSY;
   else if (!strcasecmp(val, "INVALID"))
      return AST_DEVICE_INVALID;
   else if (!strcasecmp(val, "UNAVAILABLE"))
      return AST_DEVICE_UNAVAILABLE;
   else if (!strcasecmp(val, "RINGING"))
      return AST_DEVICE_RINGING;
   else if (!strcasecmp(val, "RINGINUSE"))
      return AST_DEVICE_RINGINUSE;
   else if (!strcasecmp(val, "ONHOLD"))
      return AST_DEVICE_ONHOLD;

   return AST_DEVICE_UNKNOWN;
}

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.

Return values:

0	success
-1	failure

Definition at line 796 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 aji_init_event_distribution(), load_module(), and xmpp_init_event_distribution().

{
   if (devstate_collector.enabled) {
      return 0;
   }

   devstate_collector.event_sub = ast_event_subscribe(AST_EVENT_DEVICE_STATE_CHANGE,
      devstate_change_collector_cb, "devicestate_engine_enable_distributed", NULL, AST_EVENT_IE_END);

   if (!devstate_collector.event_sub) {
      ast_log(LOG_ERROR, "Failed to create subscription for the device state change collector\n");
      return -1;
   }

   ast_mutex_init(&devstate_collector.lock);
   ast_cond_init(&devstate_collector.cond, NULL);
   if (ast_pthread_create_background(&devstate_collector.thread, NULL, run_devstate_collector, NULL) < 0) {
      ast_log(LOG_ERROR, "Unable to start device state collector thread.\n");
      return -1;
   }

   devstate_collector.enabled = 1;

   return 0;
}

enum ast_device_state ast_parse_device_state

(

const char *

device

)

Search the Channels by Name.

Parameters:

device

like a dial string

Search the Device in active channels by compare the channel name against the device name. Compared are only the first chars to the first '-' char.

Return values:

AST_DEVICE_UNKNOWN	if no channel found
AST_DEVICE_INUSE	if a channel is found

Search the Channels by Name.

Note:

find channels with the device's name in it This function is only used for channels that does not implement devicestate natively

Definition at line 271 of file devicestate.c.

References ast_channel_get_by_name_prefix(), AST_CHANNEL_NAME, ast_channel_unref, AST_DEVICE_INUSE, AST_DEVICE_RINGING, AST_DEVICE_UNKNOWN, AST_STATE_RINGING, and match().

Referenced by _ast_device_state(), and chanavail_exec().

{
   struct ast_channel *chan;
   char match[AST_CHANNEL_NAME];
   enum ast_device_state res;

   snprintf(match, sizeof(match), "%s-", device);

   if (!(chan = ast_channel_get_by_name_prefix(match, strlen(match)))) {
      return AST_DEVICE_UNKNOWN;
   }

   res = (ast_channel_state(chan) == AST_STATE_RINGING) ? AST_DEVICE_RINGING : AST_DEVICE_INUSE;

   chan = ast_channel_unref(chan);

   return res;
}

enum ast_device_state ast_state_chan2dev

(

enum ast_channel_state

chanstate

)

Convert channel state to devicestate.

Parameters:

chanstate

Current channel state

Since:

1.6.1

Definition at line 226 of file devicestate.c.

References AST_DEVICE_UNKNOWN, chan2dev::chan, and chan2dev::dev.

{
   int i;
   chanstate &= 0xFFFF;
   for (i = 0; chan2dev[i].chan != -100; i++) {
      if (chan2dev[i].chan == chanstate) {
         return chan2dev[i].dev;
      }
   }
   return AST_DEVICE_UNKNOWN;
}

const char* devstate2str

(

enum ast_device_state

devstate

)

Convert device state to text string for output.

Parameters:

devstate

Current device state

Definition at line 221 of file devicestate.c.

{
   return devstatestring[devstate][0];
}