Asterisk - The Open Source Telephony Project: ast_channel_snapshot Struct Reference

Asterisk - The Open Source Telephony Project 18.5.0

Structure representing a snapshot of channel state. More...

#include <stasis_channels.h>

Collaboration diagram for ast_channel_snapshot:

Collaboration graph

[legend]

Data Fields
int	amaflags

struct varshead *	ari_vars

struct ast_channel_snapshot_base *	base

struct ast_channel_snapshot_bridge *	bridge

struct ast_channel_snapshot_caller *	caller

struct ast_channel_snapshot_connected *	connected

struct ast_channel_snapshot_dialplan *	dialplan

struct ast_flags	flags

struct ast_channel_snapshot_hangup *	hangup

struct varshead *	manager_vars

struct ast_channel_snapshot_peer *	peer

struct ast_flags	softhangup_flags

enum ast_channel_state	state

Detailed Description

Structure representing a snapshot of channel state.

Since: 12 While not enforced programmatically, this object is shared across multiple threads, and should be treated as an immutable object.

It is guaranteed that the segments of this snapshot will always exist when accessing the snapshot.

Definition at line 145 of file stasis_channels.h.

Field Documentation

◆ amaflags

int amaflags

AMA flags for billing

Definition at line 154 of file stasis_channels.h.

Referenced by ast_cel_create_event_with_time(), ast_channel_snapshot_create(), cdr_object_create_public_records(), cdr_object_format_property(), and handle_chanlist().

◆ ari_vars

struct varshead* ari_vars

Variables to be appended to ARI events

Definition at line 158 of file stasis_channels.h.

Referenced by ast_channel_snapshot_create(), ast_channel_snapshot_to_json(), and channel_snapshot_dtor().

◆ base

struct ast_channel_snapshot_base* base

Base information about the channel

Definition at line 146 of file stasis_channels.h.

Referenced by __test_cel_generate_peer_str(), action_coreshowchannels(), active_channels_to_str_cb(), announce_to_dial(), ast_attended_transfer_message_add_threeway(), ast_cdr_fork(), ast_cdr_setvar(), ast_cel_create_event_with_time(), ast_channel_snapshot_create(), ast_channel_snapshot_to_json(), ast_complete_channels(), ast_manager_build_channel_state_string_prefix(), AST_TEST_DEFINE(), attended_transfer_to_ami(), base_process_parked_channel(), base_process_party_a(), bridge_attended_transfer_handler(), bridge_blind_transfer_handler(), bridge_candidate_add_to_cdr(), bridge_candidate_process(), bridge_parking_push(), bridge_show_specific_print_channel(), bridge_state_process_bridge_leave(), bridge_state_process_party_b(), call_forwarded_handler(), cdr_all_print_fn(), cdr_all_relink(), cdr_master_print_fn(), cdr_object_alloc(), cdr_object_create_public_records(), cdr_object_dispatch(), cdr_object_finalize(), cdr_object_finalize_party_b(), cdr_object_format_property(), cdr_object_get_by_name_cb(), cdr_object_party_b_left_bridge_cb(), cdr_object_pick_party_a(), cdr_object_select_all_by_name_cb(), cdr_object_transition_state_init(), cdr_object_update_party_b(), cdr_object_update_party_b_userfield_cb(), cel_attended_transfer_cb(), cel_blind_transfer_cb(), cel_channel_state_change(), cel_filter_channel_snapshot(), cel_generate_peer_str(), cel_local_cb(), cel_parking_cb(), cel_pickup_cb(), chan_pjsip_devicestate(), channel_new_accountcode(), channel_snapshot_cmp_cb(), channel_snapshot_dtor(), channel_snapshot_sanitizer(), channel_snapshot_uniqueid_cmp_cb(), channels_scrape_cb(), cli_channel_compare(), cli_channel_get_id(), cli_channel_print_body(), cli_channel_sort(), cli_channelstats_compare(), cli_channelstats_print_body(), cli_channelstats_sort(), cli_complete_show(), cli_filter_channels(), cli_message_to_snapshot(), cli_show_channel(), cli_show_channels(), confbridge_handle_atxfer(), dial_state_process_bridge_enter(), dial_state_process_dial_end(), dial_state_process_party_b(), endpoint_cache_clear(), filter_channel_snapshot(), get_channel_duration(), handle_bridge_enter(), handle_bridge_enter_message(), handle_bridge_leave_message(), handle_chanlist(), handle_channel_snapshot_update_message(), handle_dial_message(), handle_hangup(), handle_local_optimization_begin(), handle_local_optimization_end(), handle_masquerade(), handle_parked_call_message(), handle_parking_bridge_enter_message(), handle_standard_bridge_enter_message(), local_message_to_ami(), log_attended_transfer(), park_announce_update_cb(), parked_state_process_bridge_leave(), parker_parked_call_message_response(), queue_agent_cb(), refer_progress_bridge(), save_dialstatus(), send_start_msg_snapshots(), single_state_bridge_enter_comparison(), single_state_process_dial_begin(), sub_channel_update_handler(), and updates().

◆ bridge

struct ast_channel_snapshot_bridge* bridge

Information about the bridge

Definition at line 150 of file stasis_channels.h.

Referenced by action_coreshowchannels(), ast_channel_snapshot_create(), channel_snapshot_dtor(), cli_channelstats_compare(), cli_channelstats_print_body(), cli_channelstats_sort(), and handle_chanlist().

◆ caller

◆ connected

struct ast_channel_snapshot_connected* connected

Information about who this channel is connected to

Definition at line 149 of file stasis_channels.h.

Referenced by ast_channel_snapshot_connected_line_equal(), ast_channel_snapshot_create(), ast_channel_snapshot_to_json(), ast_manager_build_channel_state_string_prefix(), channel_snapshot_dtor(), and cli_channel_print_body().

◆ dialplan

struct ast_channel_snapshot_dialplan* dialplan

◆ flags

struct ast_flags flags

channel flags of AST_FLAG_ type

Definition at line 155 of file stasis_channels.h.

Referenced by ast_channel_snapshot_create(), base_process_party_a(), bridge_state_process_party_b(), cdr_object_check_party_a_hangup(), cel_channel_state_change(), channel_newexten(), channel_state(), channel_state_change(), dial_state_process_party_b(), endpoint_cache_clear(), handle_channel_snapshot_update_message(), snapshot_is_dialed(), sub_channel_update_handler(), and updates().

◆ hangup

struct ast_channel_snapshot_hangup* hangup

Hangup information

Definition at line 152 of file stasis_channels.h.

Referenced by ast_channel_snapshot_create(), cdr_object_finalize(), cel_channel_state_change(), channel_destroyed_event(), channel_snapshot_dtor(), and channel_state_change().

◆ manager_vars

struct varshead* manager_vars

Variables to be appended to manager events

Definition at line 157 of file stasis_channels.h.

Referenced by ast_channel_snapshot_create(), ast_manager_build_channel_state_string_prefix(), and channel_snapshot_dtor().

◆ peer

struct ast_channel_snapshot_peer* peer

Peer information

Definition at line 147 of file stasis_channels.h.

Referenced by ast_cel_create_event_with_time(), ast_channel_publish_dial_internal(), ast_channel_snapshot_create(), ast_manager_build_channel_state_string_prefix(), base_process_party_a(), cdr_object_alloc(), cel_channel_linkedid_change(), cel_report_event(), channel_dial_cb(), channel_snapshot_dtor(), channels_scrape_cb(), check_retire_linkedid(), dial_state_process_dial_end(), handle_chanlist(), and handle_dial_message().

◆ softhangup_flags

struct ast_flags softhangup_flags

softhangup channel flags

Definition at line 156 of file stasis_channels.h.

Referenced by ast_channel_snapshot_create(), base_process_party_a(), cdr_object_check_party_a_hangup(), check_new_cdr_needed(), finalized_state_process_party_a(), and snapshot_cep_changed().

◆ state

enum ast_channel_state state

State of line

Definition at line 153 of file stasis_channels.h.

Referenced by ast_cdr_fork(), ast_channel_snapshot_create(), ast_channel_snapshot_to_json(), ast_manager_build_channel_state_string_prefix(), cdr_object_check_party_a_answer(), cel_channel_state_change(), chan_pjsip_devicestate(), channel_state(), channel_state_change(), channel_state_invalid(), cli_channel_print_body(), get_channel_state(), handle_chanlist(), and handle_channelstatus().

The documentation for this struct was generated from the following file:

stasis_channels.h