ast_bridge Struct Reference

Structure that contains information about a bridge. More...

#include <bridge.h>

Collaboration diagram for ast_bridge:

Data Fields
struct ast_string_field_mgr	__field_mgr
struct ast_string_field_pool *	__field_mgr_pool
struct {
struct ast_frame *   first
struct ast_frame *   last
}	action_queue
uint32_t	allowed_capabilities
ast_callid	callid
int	cause
struct ast_bridge_channels_list	channels
unsigned int	construction_completed:1
struct timeval	creationtime
const ast_string_field	creator
struct ast_bridge_snapshot *	current_snapshot
unsigned int	dissolved:1
struct ast_flags	feature_flags
unsigned int	inhibit_merge
	Count of the active temporary requests to inhibit bridge merges. Zero if merges are allowed. More...
struct ast_vector_int	media_types
const ast_string_field	name
unsigned int	num_active
unsigned int	num_channels
unsigned int	num_lonely
void *	personality
unsigned int	reconfigured:1
struct ast_bridge_softmix	softmix
void *	tech_pvt
struct ast_bridge_technology *	technology
struct stasis_topic *	topic
const ast_string_field	uniqueid
const struct ast_bridge_methods *	v_table

Detailed Description

Structure that contains information about a bridge.

Definition at line 357 of file bridge.h.

Field Documentation

__field_mgr

struct ast_string_field_mgr __field_mgr

Definition at line 409 of file bridge.h.

__field_mgr_pool

struct ast_string_field_pool* __field_mgr_pool

Definition at line 409 of file bridge.h.

action_queue

struct { ... } action_queue

Queue of actions to perform on the bridge.

Referenced by bridge_handle_actions(), and bridge_queue_action_nodup().

allowed_capabilities

uint32_t allowed_capabilities

Allowed bridge technology capabilities when AST_BRIDGE_FLAG_SMART enabled.

Definition at line 379 of file bridge.h.

Referenced by bridge_merge_locked(), bridges_allow_merge_optimization(), and smart_bridge_operation().

callid

ast_callid callid

Call ID associated with the bridge

Definition at line 369 of file bridge.h.

Referenced by ast_unreal_channel_push_to_bridge(), bridge_channel_internal_join(), bridge_manager_service(), destroy_bridge(), handle_showchan(), and softmix_mixing_thread().

cause

int cause

Cause code of the dissolved bridge.

Definition at line 394 of file bridge.h.

Referenced by bridge_channel_internal_join(), bridge_dissolve(), bridge_do_merge(), and bridge_do_move().

channels

struct ast_bridge_channels_list channels

Linked list of channels participating in the bridge

Definition at line 371 of file bridge.h.

Referenced by ast_bridge_channel_peer(), ast_bridge_channel_update_linkedids(), ast_bridge_peer_nolock(), ast_bridge_peers_nolock(), ast_bridge_queue_everyone_else(), ast_bridge_snapshot_create(), basic_hangup_hook(), bridge_channel_dissolve_check(), bridge_channel_internal_pull(), bridge_channel_internal_push_full(), bridge_channel_update_accountcodes_joining(), bridge_channel_update_accountcodes_leaving(), bridge_complete_join(), bridge_dissolve(), bridge_do_merge(), bridge_find_channel(), bridge_reconfigured_connected_line_update(), check_binaural_position_change(), check_bridge_play_sounds(), complete_bridge_participant(), destroy_bridge(), get_transfer_party_non_transferer_bridge(), handle_bridge_kick_channel(), holding_bridge_join(), holding_bridge_leave(), native_bridge_changed(), native_bridge_compatible(), native_bridge_join(), native_request_start(), native_rtp_bridge_compatible(), native_rtp_bridge_join(), native_rtp_bridge_start(), native_rtp_bridge_stop(), native_rtp_stream_topology_changed(), native_start(), native_stop(), on_personality_change_normal(), remove_hooks_on_personality_change(), set_bridge_peer_vars(), set_bridge_peer_vars_holding(), set_bridge_peer_vars_multiparty(), sfu_topologies_on_join(), sfu_topologies_on_source_change(), simple_bridge_join(), simple_bridge_stream_topology_changed(), smart_bridge_operation(), softmix_bridge_leave(), softmix_bridge_stream_sources_update(), softmix_bridge_stream_topology_changed(), softmix_mixing_loop(), and softmix_pass_video_top_priority().

construction_completed

unsigned int construction_completed

TRUE if the bridge construction was completed.

Definition at line 400 of file bridge.h.

Referenced by bridge_register(), and destroy_bridge().

creationtime

struct timeval creationtime

The time of bridge creation

Definition at line 416 of file bridge.h.

Referenced by ast_bridge_snapshot_create().

creator

const ast_string_field creator

Immutable name of the creator for the bridge

Definition at line 409 of file bridge.h.

Referenced by ast_bridge_snapshot_create(), bridge_tech_deferred_destroy(), and smart_bridge_operation().

current_snapshot

struct ast_bridge_snapshot* current_snapshot

Current bridge snapshot

Definition at line 414 of file bridge.h.

Referenced by ast_bridge_get_snapshot(), ast_bridge_get_snapshot_by_uniqueid(), ast_bridge_publish_state(), bridge_publish_state_from_blob(), bridge_topics_destroy(), and destroy_bridge().

dissolved

unsigned int dissolved

TRUE if the bridge has been dissolved. Any channel that now tries to join is immediately ejected.

Definition at line 398 of file bridge.h.

Referenced by bridge_allows_optimization(), bridge_channel_dissolve_check(), bridge_channel_internal_push_full(), bridge_channel_update_accountcodes_leaving(), bridge_complete_join(), bridge_dissolve(), bridge_dissolve_check_stolen(), bridge_merge_locked(), bridge_move_locked(), bridge_reconfigured(), smart_bridge_operation(), and two_bridge_attended_transfer().

feature_flags

struct ast_flags feature_flags

Bridge flags to tweak behavior

Definition at line 377 of file bridge.h.

Referenced by ast_bridge_basic_set_flags(), ast_bridge_publish_enter(), ast_bridge_publish_leave(), ast_bridge_publish_merge(), ast_bridge_snapshot_create(), ast_bridge_transfer_acquire_bridge(), ast_bridge_transfer_attended(), ast_bridge_transfer_blind(), bridge_allows_optimization(), bridge_basic_change_personality(), bridge_channel_dissolve_check(), bridge_channel_internal_push_full(), bridge_dissolve_check_stolen(), bridge_merge_locked(), bridge_move_locked(), bridge_reconfigured(), bridges_allow_merge_optimization(), bridges_allow_swap_optimization(), and channel_snapshot_bridge_create().

first

struct ast_frame* first

Definition at line 373 of file bridge.h.

inhibit_merge

unsigned int inhibit_merge

Count of the active temporary requests to inhibit bridge merges. Zero if merges are allowed.

Note

Temporary as in try again in a moment.

Definition at line 392 of file bridge.h.

Referenced by bridge_allows_optimization(), bridge_merge_inhibit_nolock(), bridge_merge_locked(), bridge_move_locked(), feature_attended_transfer(), and two_bridge_attended_transfer().

last

struct ast_frame* last

Definition at line 373 of file bridge.h.

media_types

struct ast_vector_int media_types

Type mapping used for media routing

Definition at line 412 of file bridge.h.

Referenced by ast_bridge_channel_stream_map(), bridge_alloc(), and destroy_bridge().

name

const ast_string_field name

Immutable name given to the bridge by its creator

Definition at line 409 of file bridge.h.

Referenced by ast_bridge_set_single_src_video_mode(), ast_bridge_snapshot_create(), ast_bridge_update_talker_src_video_mode(), bridge_tech_deferred_destroy(), PathSegment::get_child(), Parameter::load(), SwaggerType::load(), Property::load(), smart_bridge_operation(), and write_metadata().

num_active

unsigned int num_active

Number of active channels in the bridge.

Definition at line 383 of file bridge.h.

Referenced by ast_bridge_snapshot_create(), bridge_channel_internal_pull(), bridge_channel_internal_push_full(), bridge_channel_internal_suspend_nolock(), bridge_channel_internal_unsuspend_nolock(), smart_bridge_operation(), softmix_mixing_loop(), and softmix_mixing_thread().

num_channels

unsigned int num_channels

Number of channels participating in the bridge

Definition at line 381 of file bridge.h.

Referenced by ast_bridge_channel_peer(), ast_bridge_peer_nolock(), ast_bridge_snapshot_create(), bridge_channel_dissolve_check(), bridge_channel_internal_pull(), bridge_channel_internal_push_full(), bridge_channel_update_accountcodes_joining(), bridge_channel_update_accountcodes_leaving(), bridge_dissolve_check_stolen(), bridge_merge_locked(), bridge_prnt_obj(), bridges_allow_merge_optimization(), bridges_allow_swap_optimization(), get_transfer_party_non_transferer_bridge(), native_bridge_compatible(), native_request_start(), native_rtp_bridge_compatible(), parking_blind_transfer_park(), set_bridge_peer_vars(), set_bridge_peer_vars_multiparty(), smart_bridge_operation(), and softmix_mixing_loop().

num_lonely

unsigned int num_lonely

Number of channels with AST_BRIDGE_CHANNEL_FLAG_LONELY in the bridge.

Definition at line 385 of file bridge.h.

Referenced by bridge_channel_dissolve_check(), bridge_channel_internal_pull(), bridge_channel_internal_push_full(), and smart_bridge_operation().

personality

void* personality

"Personality" currently exhibited by bridge subclass

Definition at line 361 of file bridge.h.

Referenced by ast_bridge_basic_set_flags(), bridge_basic_change_personality(), and bridge_basic_personality_alloc().

reconfigured

unsigned int reconfigured

TRUE if the bridge was reconfigured.

Definition at line 396 of file bridge.h.

Referenced by bridge_channel_handle_control(), bridge_channel_internal_pull(), bridge_channel_internal_push_full(), bridge_channel_wait(), and bridge_reconfigured().

softmix

struct ast_bridge_softmix softmix

Softmix technology parameters.

Definition at line 375 of file bridge.h.

Referenced by add_binaural_mixing(), ast_bridge_is_video_src(), ast_bridge_number_video_src(), ast_bridge_remove_video_src(), ast_bridge_set_binaural_active(), ast_bridge_set_internal_sample_rate(), ast_bridge_set_maximum_sample_rate(), ast_bridge_set_mixing_interval(), ast_bridge_set_remb_estimated_bitrate(), ast_bridge_set_remb_send_interval(), ast_bridge_set_send_sdp_label(), ast_bridge_set_sfu_video_mode(), ast_bridge_set_single_src_video_mode(), ast_bridge_set_talker_src_video_mode(), ast_bridge_set_video_update_discard(), ast_bridge_snapshot_create(), ast_bridge_update_talker_src_video_mode(), ast_brige_set_remb_behavior(), binaural_mixing(), check_binaural_position_change(), cleanup_video_mode(), remb_collect_report(), remb_collect_report_all(), sfu_topologies_on_join(), sfu_topologies_on_source_change(), softmix_bridge_join(), softmix_bridge_leave(), softmix_bridge_stream_sources_update(), softmix_bridge_stream_topology_changed(), softmix_bridge_write_control(), softmix_bridge_write_rtcp(), softmix_bridge_write_video(), softmix_bridge_write_voice(), softmix_mixing_loop(), and softmix_mixing_thread().

tech_pvt

void* tech_pvt

Private information unique to the bridge technology

Definition at line 365 of file bridge.h.

Referenced by holding_bridge_join(), holding_bridge_leave(), holding_bridge_unsuspend(), native_bridge_create(), native_bridge_destroy(), native_bridge_start(), native_bridge_stop(), native_bridge_write(), native_request_start(), native_request_stop(), native_start(), native_stop(), remb_enable_collection(), smart_bridge_operation(), softmix_bridge_create(), softmix_bridge_destroy(), softmix_bridge_join(), softmix_bridge_leave(), softmix_bridge_stop(), softmix_bridge_stream_topology_changed(), softmix_bridge_unsuspend(), softmix_bridge_write(), softmix_bridge_write_control(), softmix_bridge_write_voice(), and softmix_mixing_loop().

technology

struct ast_bridge_technology* technology

Bridge technology that is handling the bridge

Definition at line 363 of file bridge.h.

Referenced by ast_bridge_peer_nolock(), ast_bridge_snapshot_create(), bridge_channel_complete_join(), bridge_channel_internal_join(), bridge_channel_internal_pull(), bridge_channel_internal_push_full(), bridge_channel_internal_suspend_nolock(), bridge_channel_internal_unsuspend_nolock(), bridge_channel_settle_owed_events(), bridge_channel_write_frame(), bridge_handle_trip(), bridge_merge_locked(), bridge_reconfigured_connected_line_update(), bridge_tech_deferred_destroy(), bridges_allow_merge_optimization(), deferred_action(), destroy_bridge(), set_bridge_peer_vars(), and smart_bridge_operation().

topic

struct stasis_topic* topic

Per-bridge topics

Definition at line 367 of file bridge.h.

Referenced by ast_bridge_topic(), and bridge_topics_init().

uniqueid

const ast_string_field uniqueid

Immutable bridge UUID.

Definition at line 409 of file bridge.h.

Referenced by app_control_remove_channel_from_bridge(), app_subscribe_bridge(), app_unsubscribe_bridge(), ari_bridges_play_helper(), ari_bridges_play_new(), ast_attended_transfer_message_add_merge(), ast_attended_transfer_message_add_threeway(), ast_bridge_destroy(), ast_bridge_impart(), ast_bridge_join(), ast_bridge_remove(), ast_bridge_set_single_src_video_mode(), ast_bridge_snapshot_create(), ast_bridge_update_talker_src_video_mode(), bridge_base_init(), bridge_channel_complete_join(), bridge_channel_internal_join(), bridge_channel_internal_pull(), bridge_channel_internal_push_full(), bridge_channel_settle_owed_events(), bridge_channel_wait(), bridge_dissolve(), bridge_do_merge(), bridge_do_move(), bridge_impart_internal(), bridge_merge_locked(), bridge_moh_create(), bridge_move_locked(), bridge_prnt_obj(), bridge_queue_action_nodup(), bridge_sort_cmp(), bridge_tech_deferred_destroy(), bridge_topics_init(), bridgeadd_exec(), bridges_compare(), bridges_hash(), bridgewait_exec(), channel_snapshot_bridge_create(), complete_bridge_live_search(), control_swap_channel_in_bridge(), defer_action(), destroy_bridge(), feature_attended_transfer(), forwards_create_bridge(), generate_status(), handle_showchan(), holding_bridge_join(), internal_bridge_after_cb(), native_bridge_changed(), native_bridge_compatible(), native_rtp_bridge_compatible(), native_rtp_bridge_compatible_check(), native_rtp_bridge_framehook_attach(), native_rtp_bridge_framehook_detach(), native_rtp_bridge_join(), native_rtp_bridge_leave(), native_rtp_bridge_start(), native_rtp_bridge_stop(), native_rtp_bridge_suspend(), native_rtp_bridge_unsuspend(), serialize_showchan(), smart_bridge_operation(), softmix_bridge_destroy(), softmix_bridge_join(), softmix_mixing_loop(), softmix_mixing_thread(), stasis_app_bridge_moh_channel(), stasis_app_bridge_moh_stop(), stasis_app_bridge_playback_channel_add(), stasis_app_bridge_playback_channel_find(), and try_merge_optimize_out().

v_table

const struct ast_bridge_methods* v_table

Bridge virtual method table.

Definition at line 359 of file bridge.h.

Referenced by ast_bridge_join(), ast_bridge_notify_masquerade(), ast_bridge_snapshot_create(), bridge_action_bridge(), bridge_alloc(), bridge_channel_internal_pull(), bridge_channel_internal_push_full(), bridge_impart_internal(), bridge_prnt_obj(), bridge_stasis_moving(), bridges_allow_swap_optimization(), destroy_bridge(), and feature_attended_transfer().

---

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

• bridge.h