Asterisk - The Open Source Telephony Project  21.4.1
conf_state.c
Go to the documentation of this file.
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012, Terry Wilson
5  *
6  * Terry Wilson <twilson@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18 
19 /*! \file
20  *
21  * \brief Confbridge state handling
22  *
23  * \author\verbatim Terry Wilson <twilson@digium.com> \endverbatim
24  *
25  * This file contains functions that are used from multiple conf_state
26  * files for handling stage change behavior.
27  *
28  * \ingroup applications
29  */
30 
31 /*** MODULEINFO
32  <support_level>core</support_level>
33  ***/
34 
35 #include "asterisk.h"
36 
37 #include "asterisk/logger.h"
38 #include "asterisk/test.h"
39 #include "include/conf_state.h"
40 #include "include/confbridge.h"
41 
43 {
44  ast_log(LOG_ERROR, "Invalid event for confbridge user '%s'\n", user->u_profile.name);
45 }
46 
47 /*!
48  * \internal
49  * \brief Mute the user and play MOH if the user requires it.
50  *
51  * \param user Conference user to mute and optionally start MOH on.
52  */
53 static void conf_mute_moh_inactive_waitmarked(struct confbridge_user *user)
54 {
55  /* Start music on hold if needed */
56  if (ast_test_flag(&user->u_profile, USER_OPT_MUSICONHOLD)) {
57  conf_moh_start(user);
58  }
60 }
61 
63 {
64  conf_add_user_waiting(user->conference, user);
65  conf_mute_moh_inactive_waitmarked(user);
67 }
68 
70 {
72  if (user->playing_moh) {
73  conf_moh_stop(user);
74  }
75 }
76 
77 void conf_change_state(struct confbridge_user *user, struct confbridge_state *newstate)
78 {
79  ast_debug(1, "Changing conference '%s' state from %s to %s\n", user->conference->name, user->conference->state->name, newstate->name);
80  ast_test_suite_event_notify("CONF_CHANGE_STATE", "Conference: %s\r\nOldState: %s\r\nNewState: %s\r\n",
81  user->conference->name,
82  user->conference->state->name,
83  newstate->name);
84  if (user->conference->state->exit) {
85  user->conference->state->exit(user);
86  }
87  user->conference->state = newstate;
88  if (user->conference->state->entry) {
89  user->conference->state->entry(user);
90  }
91 }
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...
Asterisk main include file. File version handling, generic pbx functions.
unsigned int playing_moh
Definition: confbridge.h:285
void conf_default_leave_waitmarked(struct confbridge_user *user)
Logic to execute every time a waitmarked user leaves an unmarked conference.
Definition: conf_state.c:69
struct confbridge_conference * conference
Definition: confbridge.h:274
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.
Test Framework API.
void conf_update_user_mute(struct confbridge_user *user)
Update the actual mute status of the user and set it on the bridge.
#define ast_debug(level,...)
Log a DEBUG message.
conference_entry_fn entry
Definition: conf_state.h:53
void conf_default_join_waitmarked(struct confbridge_user *user)
Logic to execute every time a waitmarked user joins an unmarked conference.
Definition: conf_state.c:62
struct confbridge_state * state
Definition: confbridge.h:248
#define ast_test_suite_event_notify(s, f,...)
Definition: test.h:189
void conf_moh_start(struct confbridge_user *user)
Start MOH for the conference user.
void conf_moh_stop(struct confbridge_user *user)
Stop MOH for the conference user.
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.
Support for logging to various files, console and syslog Configuration in file logger.conf.
int conf_handle_inactive_waitmarked(struct confbridge_user *user)
Handle actions every time a waitmarked user joins w/o a marked user present.
structure to hold users read from users.conf
Confbridge state handling.
A conference state object to hold the various state callback functions.
Definition: conf_state.h:45
void conf_invalid_event_fn(struct confbridge_user *user)
A handler for join/leave events that are invalid in a particular state.
Definition: conf_state.c:42
The structure that represents a conference bridge user.
Definition: confbridge.h:273
struct user_profile u_profile
Definition: confbridge.h:276
char name[MAX_CONF_NAME]
Definition: confbridge.h:247
conference_exit_fn exit
Definition: conf_state.h:54
void conf_change_state(struct confbridge_user *user, struct confbridge_state *newstate)
Execute conference state transition because of a user action.
Definition: conf_state.c:77