devicestate.h File Reference

Device state management. More...

#include "asterisk/channelstate.h"
#include "asterisk/utils.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_device_state_message
	The structure that contains device state. More...
struct	ast_devstate_aggregate
	You shouldn't care about the contents of this struct. More...

Macros
#define	ast_publish_device_state(device, state, cachable)    ast_publish_device_state_full(device, state, cachable, &ast_eid_default)
	Publish a device state update. More...

Typedefs
typedef enum ast_device_state(*	ast_devstate_prov_cb_type) (const char *data)
	Devicestate provider call back. 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...
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. More...
struct stasis_cache *	ast_device_state_cache (void)
	Backend cache for ast_device_state_topic_cached() More...
int	ast_device_state_clear_cache (const char *device)
	Clear the device from the stasis cache. More...
struct stasis_message_type *	ast_device_state_message_type (void)
	Get the Stasis message type for device state messages. More...
struct stasis_topic *	ast_device_state_topic (const char *device)
	Get the Stasis topic for device state messages for a specific device. More...
struct stasis_topic *	ast_device_state_topic_all (void)
	Get the Stasis topic for device state messages. More...
struct stasis_topic *	ast_device_state_topic_cached (void)
	Get the Stasis caching topic for device state messages. More...
const char *	ast_devstate2str (enum ast_device_state devstate) attribute_pure
	Convert device state to text string for output. More...
void	ast_devstate_aggregate_add (struct ast_devstate_aggregate *agg, enum ast_device_state state)
	Add a device state to the aggregate device state. More...
void	ast_devstate_aggregate_init (struct ast_devstate_aggregate *agg)
	Initialize aggregate device state. More...
enum ast_device_state	ast_devstate_aggregate_result (struct ast_devstate_aggregate *agg)
	Get the aggregate device state result. More...
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. More...
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. More...
int	ast_devstate_prov_add (const char *label, ast_devstate_prov_cb_type callback)
	Add device state provider. More...
int	ast_devstate_prov_del (const char *label)
	Remove device state provider. More...
const char *	ast_devstate_str (enum ast_device_state devstate) attribute_pure
	Convert device state to text string that is easier to parse. More...
enum ast_device_state	ast_devstate_val (const char *val)
	Convert device state from text to integer value. More...
enum ast_device_state	ast_parse_device_state (const char *device)
	Search the Channels by Name. More...
int	ast_publish_device_state_full (const char *device, enum ast_device_state state, enum ast_devstate_cache cachable, struct ast_eid *eid)
	Publish a device state update with EID. More...
enum ast_device_state	ast_state_chan2dev (enum ast_channel_state chanstate)
	Convert channel state to devicestate. More...
int	devstate_init (void)
	Initialize the device state core. More...

Detailed Description

Device state management.

To subscribe to device state changes, use the stasis_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.

Macro Definition Documentation

ast_publish_device_state

#define ast_publish_device_state	(		device,
			state,
			cachable
	)		ast_publish_device_state_full(device, state, cachable, &ast_eid_default)

Publish a device state update.

Parameters

[in]	device	The device name
[in]	state	The state of the device
[in]	cachable	Whether the device state can be cached

Return values

0	Success
-1	Failure

Since

12

Definition at line 321 of file devicestate.h.

Typedef Documentation

ast_devstate_prov_cb_type

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

Devicestate provider call back.

Definition at line 1 of file devicestate.h.

Enumeration Type Documentation

ast_device_state

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	Total num of device states, used for testing

Definition at line 52 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 */
};

ast_devstate_cache

enum ast_devstate_cache

Device State Cachability.

Note

This is used to define the cacheability 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 68 of file devicestate.h.

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

Function Documentation

ast_device_state()

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.

Returns

an AST_DEVICE_??? state

Definition at line 382 of file devicestate.c.

{
    /* 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);
}

References _ast_device_state().

ast_device_state_cache()

struct stasis_cache * ast_device_state_cache

(

void

)

Backend cache for ast_device_state_topic_cached()

Returns

Cache of ast_device_state_message.

Since

12

Definition at line 673 of file devicestate.c.

{
    return device_state_cache;
}

References device_state_cache.

Referenced by action_devicestatelist(), ast_device_state_clear_cache(), AST_TEST_DEFINE(), asterisk_publication_devicestate_refresh(), asterisk_start_devicestate_publishing(), cache_cleanup(), devstate_cached(), and xmpp_init_event_distribution().

ast_device_state_clear_cache()

int ast_device_state_clear_cache

(

const char *

device

)

Clear the device from the stasis cache.

Parameters

device

The device to clear

Return values

0	if successful
-1	nothing to clear

Since

12

Definition at line 688 of file devicestate.c.

{
    struct stasis_message *cached_msg;
    struct stasis_message *msg;
 
    cached_msg = stasis_cache_get_by_eid(ast_device_state_cache(),
        ast_device_state_message_type(), device, &ast_eid_default);
    if (!cached_msg) {
        /* nothing to clear */
        return -1;
    }
 
    msg = stasis_cache_clear_create(cached_msg);
    if (msg) {
        stasis_publish(ast_device_state_topic(device), msg);
    }
    ao2_cleanup(msg);
    ao2_cleanup(cached_msg);
    return 0;
}

References ao2_cleanup, ast_device_state_cache(), ast_device_state_message_type(), ast_device_state_topic(), ast_eid_default, stasis_cache_clear_create(), stasis_cache_get_by_eid(), and stasis_publish().

Referenced by stasis_app_device_state_delete().

ast_device_state_message_type()

struct stasis_message_type * ast_device_state_message_type

(

void

)

Get the Stasis message type for device state messages.

Returns

The message type for device state messages

Return values

NULL	if it has not been allocated

Since

12

Referenced by action_devicestatelist(), ast_device_state_clear_cache(), ast_publish_device_state_full(), AST_TEST_DEFINE(), asterisk_publisher_devstate_cb(), asterisk_start_devicestate_publishing(), cc_generic_agent_start_monitoring(), create_new_generic_list(), device_state_aggregate_calc(), device_state_cb(), device_state_get_id(), devstate_cached(), devstate_change_cb(), devstate_cleanup(), devstate_init(), generic_agent_devstate_cb(), generic_monitor_devstate_cb(), load_module(), load_pbx(), subscribe_device_state(), xmpp_init_event_distribution(), and xmpp_pubsub_devstate_cb().

ast_device_state_topic()

struct stasis_topic * ast_device_state_topic

(

const char *

device

)

Get the Stasis topic for device state messages for a specific device.

Parameters

device

The device for which to get the topic

Returns

The topic structure for MWI messages for a given device

Return values

NULL	if it failed to be found or allocated

Since

12

Definition at line 683 of file devicestate.c.

{
    return stasis_topic_pool_get_topic(device_state_topic_pool, device);
}

References device_state_topic_pool, and stasis_topic_pool_get_topic().

Referenced by ast_device_state_clear_cache(), ast_publish_device_state_full(), cc_generic_agent_start_monitoring(), create_new_generic_list(), device_state_aggregate_publish(), remove_device_states_cb(), and subscribe_device_state().

ast_device_state_topic_all()

struct stasis_topic * ast_device_state_topic_all

(

void

)

Get the Stasis topic for device state messages.

Returns

The topic for device state messages

Return values

NULL	if it has not been allocated

Since

12

Definition at line 668 of file devicestate.c.

{
    return device_state_topic_all;
}

References device_state_topic_all.

Referenced by ast_publish_device_state_full(), AST_TEST_DEFINE(), asterisk_start_devicestate_publishing(), devstate_init(), load_module(), load_pbx(), publish_hint_change(), publish_hint_remove(), subscribe_device_state(), and xmpp_init_event_distribution().

ast_device_state_topic_cached()

struct stasis_topic * ast_device_state_topic_cached

(

void

)

Get the Stasis caching topic for device state messages.

Returns

The caching topic for device state messages

Return values

NULL	if it has not been allocated

Since

12

Definition at line 678 of file devicestate.c.

{
    return stasis_caching_get_topic(device_state_topic_cached);
}

References device_state_topic_cached, and stasis_caching_get_topic().

Referenced by AST_TEST_DEFINE().

ast_devstate2str()

const char * ast_devstate2str

(

enum ast_device_state

devstate

)

Convert device state to text string for output.

Parameters

devstate

Current device state

Convert device state to text string for output.

Definition at line 237 of file devicestate.c.

{
    return devstatestring[devstate][0];
}

References devstatestring.

Referenced by ast_sip_get_device_state(), AST_TEST_DEFINE(), ccss_notify_device_state_change(), device_state_cb(), do_state_change(), extension_state_cb(), page_exec(), parking_notify_metermaids(), and print_queue().

ast_devstate_aggregate_add()

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

Since

1.6.1

Definition at line 636 of file devicestate.c.

{
    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;
    }
}

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(), AST_TEST_DEFINE(), chan_pjsip_devicestate(), and device_state_aggregate_calc().

ast_devstate_aggregate_init()

void ast_devstate_aggregate_init

(

struct ast_devstate_aggregate *

agg

)

Initialize aggregate device state.

Parameters

[in]

agg

the state object

Since

1.6.1

Definition at line 630 of file devicestate.c.

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

References AST_DEVICE_INVALID, and ast_devstate_aggregate::state.

Referenced by ast_extension_state3(), AST_TEST_DEFINE(), chan_pjsip_devicestate(), and device_state_aggregate_calc().

ast_devstate_aggregate_result()

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 663 of file devicestate.c.

{
    return agg->state;
}

References ast_devstate_aggregate::state.

Referenced by ast_extension_state3(), AST_TEST_DEFINE(), chan_pjsip_devicestate(), and device_state_aggregate_calc().

ast_devstate_changed()

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 510 of file devicestate.c.

{
    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);
}

References ast_devstate_changed_literal(), AST_MAX_EXTENSION, buf, and state_change::cachable.

Referenced by __expire_registry(), __iax2_poke_noanswer(), add_to_queue(), agent_devstate_changed(), ast_sip_persistent_endpoint_update_state(), calendar_devstate_change(), ccss_notify_device_state_change(), chan_pjsip_indicate(), conf_handle_first_join(), conf_run(), destroy_event(), device_state_cb(), devstate_write(), handle_cli_devstate_change(), init_queue(), join_queue(), leave_queue(), load_module(), member_add_to_queue(), member_remove_from_queue(), mwi_update_cb(), parking_notify_metermaids(), populate_cache(), reg_source_db(), register_verify(), remove_from_queue(), rt_handle_member_record(), set_queue_member_pause(), sla_change_trunk_state(), sla_handle_hold_event(), sla_station_exec(), socket_process_helper(), stasis_app_device_state_delete(), stasis_app_device_state_update(), transition_to_empty(), update_devstate(), update_registry(), and xmpp_pak_presence().

ast_devstate_changed_literal()

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 471 of file devicestate.c.

{
    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) {
        ast_publish_device_state(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;
}

References ast_calloc, ast_cond_signal, AST_DEVICE_UNKNOWN, AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_UNLOCK, AST_PTHREADT_NULL, ast_publish_device_state, state_change::cachable, change_pending, change_thread, state_change::device, do_state_change(), and state_change::list.

Referenced by ast_channel_destructor(), ast_devstate_changed(), ast_setstate(), AST_TEST_DEFINE(), chan_pjsip_indicate(), and dahdi_new().

ast_devstate_prov_add()

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 391 of file devicestate.c.

{
    struct devstate_prov *devcb;
    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_TRAVERSE(&devstate_provs, devcb, list) {
        if (!strcasecmp(devcb->label, label)) {
            ast_log(LOG_WARNING, "Device state provider '%s' already registered\n", label);
            ast_free(devprov);
            AST_RWLIST_UNLOCK(&devstate_provs);
            return -1;
        }
    }
    AST_RWLIST_INSERT_HEAD(&devstate_provs, devprov, list);
    AST_RWLIST_UNLOCK(&devstate_provs);
 
    return 0;
}

References ast_calloc, ast_copy_string(), ast_free, ast_log, AST_RWLIST_INSERT_HEAD, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, devstate_prov::callback, devstate_prov::label, and LOG_WARNING.

Referenced by AST_TEST_DEFINE(), load_module(), and load_parking_devstate().

ast_devstate_prov_del()

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 418 of file devicestate.c.

{
    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;
}

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 AST_TEST_DEFINE(), load_module(), unload_module(), and unload_parking_devstate().

ast_devstate_str()

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 255 of file devicestate.c.

{
    return devstatestring[state][1];
}

References devstatestring, and state.

Referenced by agent_handle_show_specific(), agent_show_requested(), AST_TEST_DEFINE(), asterisk_publisher_devstate_cb(), devstate_read(), devstate_to_ami(), stasis_app_device_state_to_json(), and xmpp_pubsub_devstate_cb().

ast_devstate_val()

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 260 of file devicestate.c.

{
    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;
}

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 AST_TEST_DEFINE(), asterisk_publication_devicestate(), custom_devstate_callback(), devstate_write(), handle_cli_devstate_change(), initialize_cc_devstate_map_helper(), load_module(), populate_cache(), stasis_app_device_state_update(), stasis_device_state_cb(), and xmpp_pubsub_handle_event().

ast_parse_device_state()

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 287 of file devicestate.c.

{
    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;
    }
 
    if (ast_channel_hold_state(chan) == AST_CONTROL_HOLD) {
        res = AST_DEVICE_ONHOLD;
    } else {
        res = ast_state_chan2dev(ast_channel_state(chan));
    }
    ast_channel_unref(chan);
 
    return res;
}

References ast_channel_get_by_name_prefix(), ast_channel_hold_state(), AST_CHANNEL_NAME, ast_channel_unref, AST_CONTROL_HOLD, AST_DEVICE_ONHOLD, AST_DEVICE_UNKNOWN, ast_state_chan2dev(), and match().

Referenced by _ast_device_state(), AST_TEST_DEFINE(), and chanavail_exec().

ast_publish_device_state_full()

int ast_publish_device_state_full	(	const char *	device,
		enum ast_device_state	state,
		enum ast_devstate_cache	cachable,
		struct ast_eid *	eid
	)

Publish a device state update with EID.

Parameters

[in]	device	The device name
[in]	state	The state of the device
[in]	cachable	Whether the device state can be cached
[in]	eid	The EID of the server that originally published the message

Return values

0	Success
-1	Failure

Since

12

Definition at line 709 of file devicestate.c.

{
    RAII_VAR(struct ast_device_state_message *, device_state, NULL, ao2_cleanup);
    RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
    struct stasis_topic *topic;
 
    ast_assert(!ast_strlen_zero(device));
 
    if (!ast_device_state_message_type()) {
        return -1;
    }
 
    device_state = device_state_alloc(device, state, cachable, eid);
    if (!device_state) {
        return -1;
    }
 
    message = stasis_message_create_full(ast_device_state_message_type(), device_state,
        eid);
    if (!message) {
        return -1;
    }
 
    /* When a device state is to be cached it is likely that something
     * external will either be monitoring it or will want to pull the
     * information from the cache, so we always publish to the device
     * specific topic. Cachable updates traditionally come from such things
     * as a SIP or PJSIP device.
     * When a device state is not to be cached we only publish to its
     * specific topic if something has already created the topic. Publishing
     * to its topic otherwise would create the topic, which may not be
     * necessary as it could be an ephemeral device. Uncachable updates
     * traditionally come from such things as Local channels.
     */
    if (cachable || stasis_topic_pool_topic_exists(device_state_topic_pool, device)) {
        topic = ast_device_state_topic(device);
    } else {
        topic = ast_device_state_topic_all();
    }
 
    if (!topic) {
        return -1;
    }
 
    stasis_publish(topic, message);
    return 0;
}

References ao2_cleanup, ast_assert, ast_device_state_message_type(), ast_device_state_topic(), ast_device_state_topic_all(), ast_strlen_zero(), device_state_alloc(), device_state_topic_pool, NULL, RAII_VAR, stasis_message_create_full(), stasis_publish(), and stasis_topic_pool_topic_exists().

Referenced by AST_TEST_DEFINE(), asterisk_publication_devicestate(), devstate_change_cb(), publish_device_state_to_stasis(), and xmpp_pubsub_handle_event().

ast_state_chan2dev()

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 242 of file devicestate.c.

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

References ARRAY_LEN, AST_DEVICE_UNKNOWN, and chan2dev::dev.

Referenced by ast_parse_device_state(), AST_TEST_DEFINE(), and chan_pjsip_devicestate().

devstate_init()

int devstate_init

(

void

)

Initialize the device state core.

Return values

0	Success
-1	Failure

Since

12

Definition at line 896 of file devicestate.c.

{
    ast_register_cleanup(devstate_cleanup);
 
    if (STASIS_MESSAGE_TYPE_INIT(ast_device_state_message_type) != 0) {
        return -1;
    }
    device_state_topic_all = stasis_topic_create("devicestate:all");
    if (!device_state_topic_all) {
        return -1;
    }
    device_state_topic_pool = stasis_topic_pool_create(ast_device_state_topic_all());
    if (!device_state_topic_pool) {
        return -1;
    }
    device_state_cache = stasis_cache_create_full(device_state_get_id,
        device_state_aggregate_calc, device_state_aggregate_publish);
    if (!device_state_cache) {
        return -1;
    }
    device_state_topic_cached = stasis_caching_topic_create(ast_device_state_topic_all(),
        device_state_cache);
    if (!device_state_topic_cached) {
        return -1;
    }
    stasis_caching_accept_message_type(device_state_topic_cached, ast_device_state_message_type());
    stasis_caching_set_filter(device_state_topic_cached, STASIS_SUBSCRIPTION_FILTER_SELECTIVE);
 
    devstate_message_sub = stasis_subscribe(ast_device_state_topic_all(),
        devstate_change_cb, NULL);
    if (!devstate_message_sub) {
        ast_log(LOG_ERROR, "Failed to create subscription creating uncached device state aggregate events.\n");
        return -1;
    }
    stasis_subscription_accept_message_type(devstate_message_sub, ast_device_state_message_type());
    stasis_subscription_set_filter(devstate_message_sub, STASIS_SUBSCRIPTION_FILTER_SELECTIVE);
 
    return 0;
}

References ast_device_state_message_type(), ast_device_state_topic_all(), ast_log, ast_register_cleanup(), device_state_aggregate_calc(), device_state_aggregate_publish(), device_state_cache, device_state_get_id(), device_state_topic_all, device_state_topic_cached, device_state_topic_pool, devstate_change_cb(), devstate_cleanup(), devstate_message_sub, LOG_ERROR, NULL, stasis_cache_create_full(), stasis_caching_accept_message_type(), stasis_caching_set_filter(), stasis_caching_topic_create(), STASIS_MESSAGE_TYPE_INIT, stasis_subscribe, stasis_subscription_accept_message_type(), STASIS_SUBSCRIPTION_FILTER_SELECTIVE, stasis_subscription_set_filter(), stasis_topic_create(), and stasis_topic_pool_create().

Referenced by asterisk_daemon().