Asterisk - The Open Source Telephony Project  18.5.0
Functions
conf_state.c File Reference

Confbridge state handling. More...

#include "asterisk.h"
#include "asterisk/logger.h"
#include "asterisk/test.h"
#include "include/conf_state.h"
#include "include/confbridge.h"
Include dependency graph for conf_state.c:

Go to the source code of this file.

Functions

void conf_change_state (struct confbridge_user *user, struct confbridge_state *newstate)
 Execute conference state transition because of a user action. More...
 
void conf_default_join_waitmarked (struct confbridge_user *user)
 Logic to execute every time a waitmarked user joins an unmarked conference. More...
 
void conf_default_leave_waitmarked (struct confbridge_user *user)
 Logic to execute every time a waitmarked user leaves an unmarked conference. More...
 
void conf_invalid_event_fn (struct confbridge_user *user)
 A handler for join/leave events that are invalid in a particular state. More...
 
static void conf_mute_moh_inactive_waitmarked (struct confbridge_user *user)
 

Detailed Description

Confbridge state handling.

Author
Terry Wilson <[email protected]> 

This file contains functions that are used from multiple conf_state files for handling stage change behavior.

Definition in file conf_state.c.

Function Documentation

◆ conf_change_state()

void conf_change_state ( struct confbridge_user user,
struct confbridge_state newstate 
)

Execute conference state transition because of a user action.

Parameters
userThe user that joined/left
newstateThe state to transition to

Definition at line 82 of file conf_state.c.

References ast_debug, ast_test_suite_event_notify, confbridge_user::conference, confbridge_state::entry, confbridge_state::exit, confbridge_state::name, confbridge_conference::name, and confbridge_conference::state.

Referenced by join_active(), join_marked(), join_unmarked(), join_waitmarked(), leave_active(), leave_marked(), leave_unmarked(), and leave_waitmarked().

83 {
84  ast_debug(1, "Changing conference '%s' state from %s to %s\n", user->conference->name, user->conference->state->name, newstate->name);
85  ast_test_suite_event_notify("CONF_CHANGE_STATE", "Conference: %s\r\nOldState: %s\r\nNewState: %s\r\n",
86  user->conference->name,
87  user->conference->state->name,
88  newstate->name);
89  if (user->conference->state->exit) {
90  user->conference->state->exit(user);
91  }
92  user->conference->state = newstate;
93  if (user->conference->state->entry) {
94  user->conference->state->entry(user);
95  }
96 }
struct confbridge_conference * conference
Definition: confbridge.h:272
const char * name
Definition: conf_state.h:49
#define ast_debug(level,...)
Log a DEBUG message.
Definition: logger.h:452
conference_entry_fn entry
Definition: conf_state.h:56
struct confbridge_state * state
Definition: confbridge.h:246
#define ast_test_suite_event_notify(s, f,...)
Definition: test.h:196
char name[MAX_CONF_NAME]
Definition: confbridge.h:245
conference_exit_fn exit
Definition: conf_state.h:57

◆ conf_default_join_waitmarked()

void conf_default_join_waitmarked ( struct confbridge_user user)

Logic to execute every time a waitmarked user joins an unmarked conference.

Definition at line 67 of file conf_state.c.

References conf_add_post_join_action(), conf_add_user_waiting(), conf_handle_inactive_waitmarked(), conf_mute_moh_inactive_waitmarked(), and confbridge_user::conference.

Referenced by join_waitmarked().

68 {
69  conf_add_user_waiting(user->conference, user);
72 }
static void conf_mute_moh_inactive_waitmarked(struct confbridge_user *user)
Definition: conf_state.c:58
int conf_add_post_join_action(struct confbridge_user *user, int(*func)(struct confbridge_user *user))
Queue a function to run with the given conference bridge user as an argument once the state transitio...
struct confbridge_conference * conference
Definition: confbridge.h:272
void conf_add_user_waiting(struct confbridge_conference *conference, struct confbridge_user *user)
Add a conference bridge user as an waiting user of the conference.
int conf_handle_inactive_waitmarked(struct confbridge_user *user)
Handle actions every time a waitmarked user joins w/o a marked user present.

◆ conf_default_leave_waitmarked()

void conf_default_leave_waitmarked ( struct confbridge_user user)

Logic to execute every time a waitmarked user leaves an unmarked conference.

Definition at line 74 of file conf_state.c.

References conf_moh_stop(), conf_remove_user_waiting(), confbridge_user::conference, and confbridge_user::playing_moh.

Referenced by leave_waitmarked().

75 {
77  if (user->playing_moh) {
78  conf_moh_stop(user);
79  }
80 }
unsigned int playing_moh
Definition: confbridge.h:283
struct confbridge_conference * conference
Definition: confbridge.h:272
void conf_remove_user_waiting(struct confbridge_conference *conference, struct confbridge_user *user)
Remove a conference bridge user from the waiting conference users in the conference.
void conf_moh_stop(struct confbridge_user *user)
Stop MOH for the conference user.

◆ conf_invalid_event_fn()

void conf_invalid_event_fn ( struct confbridge_user user)

A handler for join/leave events that are invalid in a particular state.

Definition at line 45 of file conf_state.c.

References ast_log, LOG_ERROR, user_profile::name, and confbridge_user::u_profile.

Referenced by handle_conf_user_join(), and handle_conf_user_leave().

46 {
47  ast_log(LOG_ERROR, "Invalid event for confbridge user '%s'\n", user->u_profile.name);
48 }
#define ast_log
Definition: astobj2.c:42
#define LOG_ERROR
Definition: logger.h:285
char name[MAX_PROFILE_NAME]
Definition: confbridge.h:153
struct user_profile u_profile
Definition: confbridge.h:274

◆ conf_mute_moh_inactive_waitmarked()

static void conf_mute_moh_inactive_waitmarked ( struct confbridge_user user)
static

Definition at line 58 of file conf_state.c.

References ast_test_flag, conf_moh_start(), conf_update_user_mute(), confbridge_user::u_profile, and USER_OPT_MUSICONHOLD.

Referenced by conf_default_join_waitmarked().

59 {
60  /* Start music on hold if needed */
62  conf_moh_start(user);
63  }
65 }
#define ast_test_flag(p, flag)
Definition: utils.h:63
void conf_update_user_mute(struct confbridge_user *user)
Update the actual mute status of the user and set it on the bridge.
void conf_moh_start(struct confbridge_user *user)
Start MOH for the conference user.
struct user_profile u_profile
Definition: confbridge.h:274