extension_state.h File Reference

#include "asterisk/pbx.h"

Include dependency graph for extension_state.h:

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

Go to the source code of this file.

Data Structures
struct	ast_extension_state_device_snapshot
	Device snapshot for an extension state. More...
struct	ast_extension_state_device_state_info
	Individual device states that contributed to snapshot. More...
struct	ast_extension_state_presence_snapshot
	Presence snapshot for an extension state. More...
struct	ast_extension_state_remove_message
	Stasis message for extension state removal message. More...
struct	ast_extension_state_update_message
	Stasis message for extension state update message. More...

Functions
struct ast_channel *	ast_extension_state_get_device_causing_channel (const char *device, enum ast_device_state device_state)
	Get the channel that is causing the device to be in the given state, if any.
struct ast_extension_state_device_snapshot *	ast_extension_state_get_latest_device_snapshot (struct ast_channel *chan, const char *exten, const char *context)
	Get the latest device state message for an extension.
struct ast_extension_state_presence_snapshot *	ast_extension_state_get_latest_presence_snapshot (struct ast_channel *chan, const char *exten, const char *context)
	Get the latest presence state message for an extension.
struct stasis_message_type *	ast_extension_state_remove_message_type (void)
	Get extension state remove message type.
struct stasis_topic *	ast_extension_state_topic (const char *exten, const char *context)
	Get the Stasis topic to receive extension state messages for a specific extension.
struct stasis_topic *	ast_extension_state_topic_all (void)
	Get the Stasis topic to receive all extension state messages.
struct stasis_message_type *	ast_extension_state_update_message_type (void)
	Get extension state update message type.

Detailed Description

API providing extension state management.

Definition in file extension_state.h.

Function Documentation

ast_extension_state_get_device_causing_channel()

struct ast_channel * ast_extension_state_get_device_causing_channel	(	const char *	device,
		enum ast_device_state	device_state
	)

Get the channel that is causing the device to be in the given state, if any.

Since

23.5.0

22.11.0

20.21.0

Parameters

device	The device itself
device_state	The state of the device

Returns

The channel that is causing the device to be in the given state

Return values

NULL	if there is no channel causing the device to be in the given state

Definition at line 1070 of file extension_state.c.

{
    enum ast_channel_state search_state = 0; /* prevent false uninit warning */
    char match[AST_CHANNEL_NAME];
    struct ast_channel_iterator *chan_iter;
    struct ast_channel *chan, *channel = NULL;
    struct timeval chantime = {0, }; /* prevent false uninit warning */
 
    switch (device_state) {
    case AST_DEVICE_RINGING:
    case AST_DEVICE_RINGINUSE:
        /* find ringing channel */
        search_state = AST_STATE_RINGING;
        break;
    case AST_DEVICE_BUSY:
        /* find busy channel */
        search_state = AST_STATE_BUSY;
        break;
    case AST_DEVICE_ONHOLD:
    case AST_DEVICE_INUSE:
        /* find up channel */
        search_state = AST_STATE_UP;
        break;
    case AST_DEVICE_UNKNOWN:
    case AST_DEVICE_NOT_INUSE:
    case AST_DEVICE_INVALID:
    case AST_DEVICE_UNAVAILABLE:
    case AST_DEVICE_TOTAL /* not a state */:
        /* no channels are of interest */
        return NULL;
    }
 
    /* iterate over all channels of the device */
    snprintf(match, sizeof(match), "%s-", device);
    chan_iter = ast_channel_iterator_by_name_new(match, strlen(match));
    for (; (chan = ast_channel_iterator_next(chan_iter)); ast_channel_unref(chan)) {
        ast_channel_lock(chan);
        /* this channel's state doesn't match */
        if (search_state != ast_channel_state(chan)) {
            ast_channel_unlock(chan);
            continue;
        }
        /* any non-ringing channel will fit */
        if (search_state != AST_STATE_RINGING) {
            ast_channel_unlock(chan);
            channel = chan;
            break;
        }
        /* but we need the oldest ringing channel of the device to match with undirected pickup */
        if (!channel) {
            chantime = ast_channel_creationtime(chan);
            ast_channel_ref(chan); /* must ref it! */
            channel = chan;
        } else if (ast_tvcmp(ast_channel_creationtime(chan), chantime) < 0) {
            chantime = ast_channel_creationtime(chan);
            ast_channel_unref(channel);
            ast_channel_ref(chan); /* must ref it! */
            channel = chan;
        }
        ast_channel_unlock(chan);
    }
    ast_channel_iterator_destroy(chan_iter);
 
    return channel;
}

References ast_channel_creationtime(), ast_channel_iterator_by_name_new(), ast_channel_iterator_destroy(), ast_channel_iterator_next(), ast_channel_lock, AST_CHANNEL_NAME, ast_channel_ref, ast_channel_unlock, ast_channel_unref, AST_DEVICE_BUSY, AST_DEVICE_INUSE, AST_DEVICE_INVALID, AST_DEVICE_NOT_INUSE, AST_DEVICE_ONHOLD, AST_DEVICE_RINGING, AST_DEVICE_RINGINUSE, AST_DEVICE_TOTAL, AST_DEVICE_UNAVAILABLE, AST_DEVICE_UNKNOWN, AST_STATE_BUSY, AST_STATE_RINGING, AST_STATE_UP, ast_tvcmp(), match(), and NULL.

Referenced by extension_state_legacy_create_device_state_info().

ast_extension_state_get_latest_device_snapshot()

struct ast_extension_state_device_snapshot * ast_extension_state_get_latest_device_snapshot	(	struct ast_channel *	chan,
		const char *	exten,
		const char *	context
	)

Get the latest device state message for an extension.

Since

23.5.0

22.11.0

20.21.0

Parameters

chan	The optional channel to get the underlying hint from, if it needs to be created
exten	The extension to get the device state message for
context	The context of the extension

Returns

The latest device snapshot for the extension

Return values

NULL	if the extension does not have a configured hint

Definition at line 1317 of file extension_state.c.

{
    struct extension_state *state;
    struct ast_extension_state_device_snapshot *device_snapshot;
 
    state = extension_state_get(chan, context, exten);
    if (!state) {
        return NULL;
    }
 
    ao2_lock(state);
    device_snapshot = ao2_bump(state->device_snapshot);
    ao2_unlock(state);
    ao2_ref(state, -1);
 
    return device_snapshot;
}

References ao2_bump, ao2_lock, ao2_ref, ao2_unlock, extension_state_get(), and NULL.

Referenced by ast_extension_state(), and ast_extension_state_extended().

ast_extension_state_get_latest_presence_snapshot()

struct ast_extension_state_presence_snapshot * ast_extension_state_get_latest_presence_snapshot	(	struct ast_channel *	chan,
		const char *	exten,
		const char *	context
	)

Get the latest presence state message for an extension.

Since

23.5.0

22.11.0

20.21.0

Parameters

chan	The optional channel to get the underlying hint from, if it needs to be created
exten	The extension to get the presence state message for
context	The context of the extension

Returns

The latest presence snapshot for the extension

Return values

NULL	if the extension does not have a configured hint

Definition at line 1336 of file extension_state.c.

{
    struct extension_state *state;
    struct ast_extension_state_presence_snapshot *presence_snapshot;
 
    state = extension_state_get(chan, context, exten);
    if (!state) {
        return NULL;
    }
 
    ao2_lock(state);
    presence_snapshot = ao2_bump(state->presence_snapshot);
    ao2_unlock(state);
    ao2_ref(state, -1);
 
    return presence_snapshot;
}

References ao2_bump, ao2_lock, ao2_ref, ao2_unlock, extension_state_get(), and NULL.

Referenced by ast_hint_presence_state().

ast_extension_state_remove_message_type()

struct stasis_message_type * ast_extension_state_remove_message_type

(

void

)

Get extension state remove message type.

Since

23.5.0

22.11.0

20.21.0

Return values

Stasis

message type for extension state remove messages

Referenced by ast_extension_state_init(), extension_state_cleanup(), extension_state_legacy_add_destroy(), and extension_state_remove_message_create().

ast_extension_state_topic()

struct stasis_topic * ast_extension_state_topic	(	const char *	exten,
		const char *	context
	)

Get the Stasis topic to receive extension state messages for a specific extension.

Since

23.5.0

22.11.0

20.21.0

Parameters

exten	The extension to receive extension state messages for
context	The context of the extension

Returns

The topic for extension state messages

Return values

NULL	if it has not been allocated

Definition at line 1299 of file extension_state.c.

{
    struct extension_state *state;
    struct stasis_topic *topic;
 
    state = extension_state_get(NULL, context, exten);
    if (!state) {
        return NULL;
    }
 
    ao2_lock(state);
    topic = ao2_bump(state->extension_state_topic);
    ao2_unlock(state);
    ao2_ref(state, -1);
 
    return topic;
}

References ao2_bump, ao2_lock, ao2_ref, ao2_unlock, extension_state_get(), and NULL.

Referenced by extension_state_legacy_add_destroy().

ast_extension_state_topic_all()

struct stasis_topic * ast_extension_state_topic_all

(

void

)

Get the Stasis topic to receive all extension state messages.

Since

23.5.0

22.11.0

20.21.0

Returns

The topic for extension state messages

Return values

NULL	if it has not been allocated

Definition at line 1294 of file extension_state.c.

{
    return extension_state_topic_all;
}

References extension_state_topic_all.

Referenced by extension_state_legacy_add_destroy().

ast_extension_state_update_message_type()

struct stasis_message_type * ast_extension_state_update_message_type

(

void

)

Get extension state update message type.

Since

23.5.0

22.11.0

20.21.0

Return values

Stasis

message type for extension state update messages

Referenced by ast_extension_state_init(), extension_state_cleanup(), extension_state_device_state_cb(), extension_state_legacy_add_destroy(), extension_state_presence_state_cb(), and extension_state_update_sources().