stasis_channels.h File Reference

#include "asterisk/stringfields.h"
#include "asterisk/stasis.h"
#include "asterisk/channel.h"

Include dependency graph for stasis_channels.h:

Go to the source code of this file.

Data Structures
struct	ast_channel_blob
	Blob of data associated with a channel. More...
struct	ast_channel_snapshot
	Structure representing a snapshot of channel state. More...
struct	ast_channel_snapshot_base
	Structure containing base information for a channel snapshot. More...
struct	ast_channel_snapshot_bridge
	Structure containing bridge information for a channel snapshot. More...
struct	ast_channel_snapshot_caller
	Structure containing caller information for a channel snapshot. More...
struct	ast_channel_snapshot_connected
	Structure containing connected information for a channel snapshot. More...
struct	ast_channel_snapshot_dialplan
	Structure containing dialplan information for a channel snapshot. More...
struct	ast_channel_snapshot_hangup
	Structure containing hangup information for a channel snapshot. More...
struct	ast_channel_snapshot_peer
	Structure containing peer information for a channel snapshot. More...
struct	ast_channel_snapshot_update
	Structure representing a change of snapshot of channel state. More...

Enumerations
enum	ast_channel_snapshot_segment_invalidation {   AST_CHANNEL_SNAPSHOT_INVALIDATE_BRIDGE = (1 << 1) , AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN = (1 << 2) , AST_CHANNEL_SNAPSHOT_INVALIDATE_CONNECTED = (1 << 3) , AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER = (1 << 4) ,   AST_CHANNEL_SNAPSHOT_INVALIDATE_HANGUP = (1 << 5) , AST_CHANNEL_SNAPSHOT_INVALIDATE_PEER = (1 << 6) , AST_CHANNEL_SNAPSHOT_INVALIDATE_BASE = (1 << 7) }
	Channel snapshot invalidation flags, used to force generation of segments. More...

Functions
struct stasis_message_type *	ast_channel_agent_login_type (void)
	Message type for agent login on a channel. More...
struct stasis_message_type *	ast_channel_agent_logoff_type (void)
	Message type for agent logoff on a channel. More...
struct stasis_message *	ast_channel_blob_create (struct ast_channel *chan, struct stasis_message_type *type, struct ast_json *blob)
	Creates a ast_channel_blob message. More...
struct stasis_message *	ast_channel_blob_create_from_cache (const char *uniqueid, struct stasis_message_type *type, struct ast_json *blob)
	Create a ast_channel_blob message, pulling channel state from the cache. More...
struct ao2_container *	ast_channel_cache_all (void)
struct ao2_container *	ast_channel_cache_by_name (void)
	Secondary channel cache, indexed by name. More...
struct stasis_message_type *	ast_channel_chanspy_start_type (void)
	Message type for when a channel starts spying on another channel. More...
struct stasis_message_type *	ast_channel_chanspy_stop_type (void)
	Message type for when a channel stops spying on another channel. More...
struct stasis_message_type *	ast_channel_dial_type (void)
	Message type for when a channel dials another channel. More...
struct stasis_message_type *	ast_channel_dtmf_begin_type (void)
	Message type for when DTMF begins on a channel. More...
struct stasis_message_type *	ast_channel_dtmf_end_type (void)
	Message type for when DTMF ends on a channel. More...
struct stasis_message_type *	ast_channel_fax_type (void)
	Message type for a fax operation. More...
struct stasis_message_type *	ast_channel_flash_type (void)
	Message type for when a hook flash occurs on a channel. More...
struct stasis_message_type *	ast_channel_hangup_handler_type (void)
	Message type for hangup handler related actions. More...
struct stasis_message_type *	ast_channel_hangup_request_type (void)
	Message type for when a hangup is requested on a channel. More...
struct stasis_message_type *	ast_channel_hold_type (void)
	Message type for when a channel is placed on hold. More...
struct stasis_message_type *	ast_channel_masquerade_type (void)
	Message type for when a channel is being masqueraded. More...
struct stasis_message_type *	ast_channel_mixmonitor_mute_type (void)
	Message type for muting or unmuting mixmonitor on a channel. More...
struct stasis_message_type *	ast_channel_mixmonitor_start_type (void)
	Message type for starting mixmonitor on a channel. More...
struct stasis_message_type *	ast_channel_mixmonitor_stop_type (void)
	Message type for stopping mixmonitor on a channel. More...
struct stasis_message_type *	ast_channel_moh_start_type (void)
	Message type for starting music on hold on a channel. More...
struct stasis_message_type *	ast_channel_moh_stop_type (void)
	Message type for stopping music on hold on a channel. More...
void	ast_channel_publish_blob (struct ast_channel *chan, struct stasis_message_type *type, struct ast_json *blob)
	Publish a channel blob message. More...
void	ast_channel_publish_cached_blob (struct ast_channel *chan, struct stasis_message_type *type, struct ast_json *blob)
	Publish a channel blob message using the latest snapshot from the cache. More...
void	ast_channel_publish_dial (struct ast_channel *caller, struct ast_channel *peer, const char *dialstring, const char *dialstatus)
	Publish in the ast_channel_topic or ast_channel_topic_all topics a stasis message for the channels involved in a dial operation. More...
void	ast_channel_publish_dial_forward (struct ast_channel *caller, struct ast_channel *peer, struct ast_channel *forwarded, const char *dialstring, const char *dialstatus, const char *forward)
	Publish in the ast_channel_topic or ast_channel_topic_all topics a stasis message for the channels involved in a dial operation that is forwarded. More...
void	ast_channel_publish_final_snapshot (struct ast_channel *chan)
	Send the final channel snapshot for a channel, thus removing it from cache. More...
void	ast_channel_publish_snapshot (struct ast_channel *chan)
	Publish a ast_channel_snapshot for a channel. More...
void	ast_channel_publish_varset (struct ast_channel *chan, const char *variable, const char *value)
	Publish a ast_channel_publish_varset for a channel. More...
int	ast_channel_snapshot_caller_id_equal (const struct ast_channel_snapshot *old_snapshot, const struct ast_channel_snapshot *new_snapshot)
	Compares the callerid info of two snapshots. More...
int	ast_channel_snapshot_cep_equal (const struct ast_channel_snapshot *old_snapshot, const struct ast_channel_snapshot *new_snapshot)
	Compares the context, exten and priority of two snapshots. More...
int	ast_channel_snapshot_connected_line_equal (const struct ast_channel_snapshot *old_snapshot, const struct ast_channel_snapshot *new_snapshot)
	Compares the connected line info of two snapshots. More...
struct ast_channel_snapshot *	ast_channel_snapshot_create (struct ast_channel *chan)
	Generate a snapshot of the channel state. This is an ao2 object, so ao2_cleanup() to deallocate. More...
struct ast_channel_snapshot *	ast_channel_snapshot_get_latest (const char *uniqueid)
	Obtain the latest ast_channel_snapshot from the Stasis Message Bus API cache. This is an ao2 object, so use ao2_cleanup() to deallocate. More...
struct ast_channel_snapshot *	ast_channel_snapshot_get_latest_by_name (const char *name)
	Obtain the latest ast_channel_snapshot from the Stasis Message Bus API cache. This is an ao2 object, so use ao2_cleanup() to deallocate. More...
void	ast_channel_snapshot_invalidate_segment (struct ast_channel *chan, enum ast_channel_snapshot_segment_invalidation segment)
	Invalidate a channel snapshot segment from being reused. More...
struct ast_json *	ast_channel_snapshot_to_json (const struct ast_channel_snapshot *snapshot, const struct stasis_message_sanitizer *sanitize)
	Build a JSON object from a ast_channel_snapshot. More...
struct stasis_message_type *	ast_channel_snapshot_type (void)
	Message type for ast_channel_snapshot_update. More...
void	ast_channel_stage_snapshot (struct ast_channel *chan)
	Set flag to indicate channel snapshot is being staged. More...
void	ast_channel_stage_snapshot_done (struct ast_channel *chan)
	Clear flag to indicate channel snapshot is being staged, and publish snapshot. More...
struct stasis_message_type *	ast_channel_talking_start (void)
	Message type for a channel starting talking. More...
struct stasis_message_type *	ast_channel_talking_stop (void)
	Message type for a channel stopping talking. More...
struct stasis_message_type *	ast_channel_tone_detect (void)
	Message type for a channel tone detection. More...
struct stasis_topic *	ast_channel_topic_all (void)
	A topic which publishes the events for all channels. More...
struct stasis_message_type *	ast_channel_unhold_type (void)
	Message type for when a channel is removed from hold. More...
struct stasis_message_type *	ast_channel_varset_type (void)
	Message type for when a variable is set on a channel. More...
struct stasis_message_type *	ast_channel_wink_type (void)
	Message type for when a wink occurs on a channel. More...
void	ast_multi_channel_blob_add_channel (struct ast_multi_channel_blob *obj, const char *role, struct ast_channel_snapshot *snapshot)
	Add a ast_channel_snapshot to a ast_multi_channel_blob object. More...
struct ast_multi_channel_blob *	ast_multi_channel_blob_create (struct ast_json *blob)
	Create a ast_multi_channel_blob suitable for a stasis_message. More...
struct ast_channel_snapshot *	ast_multi_channel_blob_get_channel (struct ast_multi_channel_blob *obj, const char *role)
	Retrieve a channel snapshot associated with a specific role from a ast_multi_channel_blob. More...
struct ao2_container *	ast_multi_channel_blob_get_channels (struct ast_multi_channel_blob *obj, const char *role)
	Retrieve all channel snapshots associated with a specific role from a ast_multi_channel_blob. More...
struct ast_json *	ast_multi_channel_blob_get_json (struct ast_multi_channel_blob *obj)
	Retrieve the JSON blob from a ast_multi_channel_blob. Returned ast_json is still owned by obj. More...
int	ast_stasis_channels_init (void)
	Initialize the stasis channel topic and message types. More...

Function Documentation

ast_channel_snapshot_caller_id_equal()

int ast_channel_snapshot_caller_id_equal	(	const struct ast_channel_snapshot *	old_snapshot,
		const struct ast_channel_snapshot *	new_snapshot
	)

Compares the callerid info of two snapshots.

Since

12

Parameters

old_snapshot	Old snapshot
new_snapshot	New snapshot

Return values

True	(non-zero) if callerid are identical.
False	(zero) if callerid changed.

Definition at line 1361 of file stasis_channels.c.

{
    ast_assert(old_snapshot != NULL);
    ast_assert(new_snapshot != NULL);
    return strcmp(old_snapshot->caller->number, new_snapshot->caller->number) == 0 &&
        strcmp(old_snapshot->caller->name, new_snapshot->caller->name) == 0;
}

References ast_assert, ast_channel_snapshot::caller, ast_channel_snapshot_caller::name, NULL, and ast_channel_snapshot_caller::number.

Referenced by channel_callerid(), and channel_new_callerid().

ast_channel_snapshot_cep_equal()

int ast_channel_snapshot_cep_equal	(	const struct ast_channel_snapshot *	old_snapshot,
		const struct ast_channel_snapshot *	new_snapshot
	)

Compares the context, exten and priority of two snapshots.

Since

12

Parameters

old_snapshot	Old snapshot
new_snapshot	New snapshot

Return values

True	(non-zero) if context, exten or priority are identical.
False	(zero) if context, exten and priority changed.

Definition at line 1340 of file stasis_channels.c.

{
    ast_assert(old_snapshot != NULL);
    ast_assert(new_snapshot != NULL);
 
    /* We actually get some snapshots with CEP set, but before the
     * application is set. Since empty application is invalid, we treat
     * setting the application from nothing as a CEP change.
     */
    if (ast_strlen_zero(old_snapshot->dialplan->appl) &&
        !ast_strlen_zero(new_snapshot->dialplan->appl)) {
        return 0;
    }
 
    return old_snapshot->dialplan->priority == new_snapshot->dialplan->priority &&
        strcmp(old_snapshot->dialplan->context, new_snapshot->dialplan->context) == 0 &&
        strcmp(old_snapshot->dialplan->exten, new_snapshot->dialplan->exten) == 0;
}

References ast_channel_snapshot_dialplan::appl, ast_assert, ast_strlen_zero(), ast_channel_snapshot_dialplan::context, ast_channel_snapshot::dialplan, ast_channel_snapshot_dialplan::exten, NULL, and ast_channel_snapshot_dialplan::priority.

Referenced by channel_dialplan(), and channel_newexten().

ast_channel_snapshot_connected_line_equal()

int ast_channel_snapshot_connected_line_equal	(	const struct ast_channel_snapshot *	old_snapshot,
		const struct ast_channel_snapshot *	new_snapshot
	)

Compares the connected line info of two snapshots.

Since

13.1.0

Parameters

old_snapshot	Old snapshot
new_snapshot	New snapshot

Return values

True	(non-zero) if callerid are identical.
False	(zero) if callerid changed.

Definition at line 1371 of file stasis_channels.c.

{
    ast_assert(old_snapshot != NULL);
    ast_assert(new_snapshot != NULL);
    return strcmp(old_snapshot->connected->number, new_snapshot->connected->number) == 0 &&
        strcmp(old_snapshot->connected->name, new_snapshot->connected->name) == 0;
}

References ast_assert, ast_channel_snapshot::connected, ast_channel_snapshot_connected::name, NULL, and ast_channel_snapshot_connected::number.

Referenced by channel_connected_line(), and channel_new_connected_line().

ast_channel_snapshot_to_json()

struct ast_json * ast_channel_snapshot_to_json	(	const struct ast_channel_snapshot *	snapshot,
		const struct stasis_message_sanitizer *	sanitize
	)

Build a JSON object from a ast_channel_snapshot.

Parameters

snapshot	The snapshot to convert to JSON
sanitize	The message sanitizer to use on the snapshot

Returns

JSON object representing channel snapshot.

Return values

NULL

on error

Definition at line 1289 of file stasis_channels.c.

{
    struct ast_json *json_chan;
 
    if (snapshot == NULL
        || (sanitize
            && sanitize->channel_snapshot
            && sanitize->channel_snapshot(snapshot))) {
        return NULL;
    }
 
    json_chan = ast_json_pack(
        /* Broken up into groups for readability */
        "{ s: s, s: s, s: s, s: s,"
        "  s: o, s: o, s: s,"
        "  s: o, s: o, s: s }",
        /* First line */
        "id", snapshot->base->uniqueid,
        "name", snapshot->base->name,
        "state", ast_state2str(snapshot->state),
        "protocol_id", snapshot->base->protocol_id,
        /* Second line */
        "caller", ast_json_name_number(
            snapshot->caller->name, snapshot->caller->number),
        "connected", ast_json_name_number(
            snapshot->connected->name, snapshot->connected->number),
        "accountcode", snapshot->base->accountcode,
        /* Third line */
        "dialplan", ast_json_dialplan_cep_app(
            snapshot->dialplan->context, snapshot->dialplan->exten, snapshot->dialplan->priority,
            snapshot->dialplan->appl, snapshot->dialplan->data),
        "creationtime", ast_json_timeval(snapshot->base->creationtime, NULL),
        "language", snapshot->base->language);
 
    if (!ast_strlen_zero(snapshot->caller->rdnis)) {
        ast_json_object_set(json_chan, "caller_rdnis", ast_json_string_create(snapshot->caller->rdnis));
    }
 
    if (snapshot->ari_vars && !AST_LIST_EMPTY(snapshot->ari_vars)) {
        ast_json_object_set(json_chan, "channelvars", ast_json_channel_vars(snapshot->ari_vars));
    }
 
        if (!ast_strlen_zero(snapshot->base->tenantid)) {
                ast_json_object_set(json_chan, "tenantid", ast_json_string_create(snapshot->base->tenantid));
        }
 
    return json_chan;
}

References ast_channel_snapshot_base::accountcode, ast_channel_snapshot_dialplan::appl, ast_channel_snapshot::ari_vars, ast_json_channel_vars(), ast_json_dialplan_cep_app(), ast_json_name_number(), ast_json_object_set(), ast_json_pack(), ast_json_string_create(), ast_json_timeval(), AST_LIST_EMPTY, ast_state2str(), ast_strlen_zero(), ast_channel_snapshot::base, ast_channel_snapshot::caller, stasis_message_sanitizer::channel_snapshot, ast_channel_snapshot::connected, ast_channel_snapshot_dialplan::context, ast_channel_snapshot_base::creationtime, ast_channel_snapshot_dialplan::data, ast_channel_snapshot::dialplan, ast_channel_snapshot_dialplan::exten, ast_channel_snapshot_base::language, ast_channel_snapshot_caller::name, ast_channel_snapshot_connected::name, ast_channel_snapshot_base::name, NULL, ast_channel_snapshot_caller::number, ast_channel_snapshot_connected::number, ast_channel_snapshot_dialplan::priority, ast_channel_snapshot_caller::rdnis, ast_channel_snapshot::state, ast_channel_snapshot_base::tenantid, and ast_channel_snapshot_base::uniqueid.

Referenced by ari_channels_handle_originate_with_id(), ari_channels_handle_snoop_channel(), ast_ari_channels_create(), ast_ari_channels_get(), ast_ari_channels_list(), AST_TEST_DEFINE(), attended_transfer_to_json(), blind_transfer_to_json(), channel_blob_to_json(), channel_callerid(), channel_connected_line(), channel_destroyed_event(), channel_dialplan(), channel_to_json(), dial_to_json(), dtmf_end_to_json(), hold_to_json(), multi_user_event_to_json(), rtcp_report_to_json(), simple_bridge_channel_event(), simple_channel_event(), stasis_app_exec(), stasis_end_to_json(), stasis_start_to_json(), and unhold_to_json().

ast_stasis_channels_init()

int ast_stasis_channels_init

(

void

)

Initialize the stasis channel topic and message types.

Return values

0	on success
Non-zero	on error

Definition at line 1718 of file stasis_channels.c.

{
    int res = 0;
 
    ast_register_cleanup(stasis_channels_cleanup);
 
    channel_topic_all = stasis_topic_create("channel:all");
    if (!channel_topic_all) {
        return -1;
    }
 
    channel_cache = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_RWLOCK,
        0, AST_NUM_CHANNEL_BUCKETS, channel_snapshot_uniqueid_hash_cb,
        NULL, channel_snapshot_uniqueid_cmp_cb);
    if (!channel_cache) {
        return -1;
    }
 
    channel_cache_by_name = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_RWLOCK,
        0, AST_NUM_CHANNEL_BUCKETS, channel_snapshot_hash_cb,
        NULL, channel_snapshot_cmp_cb);
    if (!channel_cache_by_name) {
        return -1;
    }
 
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_agent_login_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_agent_logoff_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_snapshot_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_dial_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_varset_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_hangup_request_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_masquerade_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_dtmf_begin_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_dtmf_end_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_flash_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_wink_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_hold_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_unhold_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_chanspy_start_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_chanspy_stop_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_fax_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_hangup_handler_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_moh_start_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_moh_stop_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_mixmonitor_start_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_mixmonitor_stop_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_mixmonitor_mute_type);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_talking_start);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_talking_stop);
    res |= STASIS_MESSAGE_TYPE_INIT(ast_channel_tone_detect);
 
    return res;
}

References AO2_ALLOC_OPT_LOCK_RWLOCK, ao2_container_alloc_hash, ast_channel_agent_login_type(), ast_channel_agent_logoff_type(), ast_channel_chanspy_start_type(), ast_channel_chanspy_stop_type(), ast_channel_dial_type(), ast_channel_dtmf_begin_type(), ast_channel_dtmf_end_type(), ast_channel_fax_type(), ast_channel_flash_type(), ast_channel_hangup_handler_type(), ast_channel_hangup_request_type(), ast_channel_hold_type(), ast_channel_masquerade_type(), ast_channel_mixmonitor_mute_type(), ast_channel_mixmonitor_start_type(), ast_channel_mixmonitor_stop_type(), ast_channel_moh_start_type(), ast_channel_moh_stop_type(), ast_channel_snapshot_type(), ast_channel_talking_start(), ast_channel_talking_stop(), ast_channel_tone_detect(), ast_channel_unhold_type(), ast_channel_varset_type(), ast_channel_wink_type(), AST_NUM_CHANNEL_BUCKETS, ast_register_cleanup(), channel_cache, channel_cache_by_name, channel_snapshot_cmp_cb(), channel_snapshot_hash_cb(), channel_snapshot_uniqueid_cmp_cb(), channel_snapshot_uniqueid_hash_cb(), channel_topic_all, NULL, stasis_channels_cleanup(), STASIS_MESSAGE_TYPE_INIT, and stasis_topic_create().

Referenced by ast_channels_init().