Fix documentation replication issues
[asterisk/asterisk.git] / apps / confbridge / conf_state.c
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  * Please follow coding guidelines
19  * http://svn.digium.com/view/asterisk/trunk/doc/CODING-GUIDELINES
20  */
21
22 /*! \file
23  *
24  * \brief Confbridge state handling
25  *
26  * \author\verbatim Terry Wilson <twilson@digium.com> \endverbatim
27  *
28  * This file contains functions that are used from multiple conf_state
29  * files for handling stage change behavior.
30  *
31  * \ingroup applications
32  */
33
34 /*** MODULEINFO
35         <support_level>core</support_level>
36  ***/
37
38 #include "asterisk.h"
39
40 #include "asterisk/logger.h"
41 #include "asterisk/test.h"
42 #include "include/conf_state.h"
43 #include "include/confbridge.h"
44
45 void conf_invalid_event_fn(struct confbridge_user *user)
46 {
47         ast_log(LOG_ERROR, "Invalid event for confbridge user '%s'\n", user->u_profile.name);
48 }
49
50 /*!
51  * \internal
52  * \brief Mute the user and play MOH if the user requires it.
53  *
54  * \param user Conference user to mute and optionally start MOH on.
55  *
56  * \return Nothing
57  */
58 static void conf_mute_moh_inactive_waitmarked(struct confbridge_user *user)
59 {
60         /* Be sure we are muted so we can't talk to anybody else waiting */
61         user->features.mute = 1;
62         /* Start music on hold if needed */
63         if (ast_test_flag(&user->u_profile, USER_OPT_MUSICONHOLD)) {
64                 conf_moh_start(user);
65         }
66 }
67
68 void conf_default_join_waitmarked(struct confbridge_user *user)
69 {
70         conf_add_user_waiting(user->conference, user);
71         conf_mute_moh_inactive_waitmarked(user);
72         conf_add_post_join_action(user, conf_handle_inactive_waitmarked);
73 }
74
75 void conf_default_leave_waitmarked(struct confbridge_user *user)
76 {
77         conf_remove_user_waiting(user->conference, user);
78 }
79
80 void conf_change_state(struct confbridge_user *user, struct confbridge_state *newstate)
81 {
82         ast_debug(1, "Changing conference '%s' state from %s to %s\n", user->conference->name, user->conference->state->name, newstate->name);
83         ast_test_suite_event_notify("CONF_CHANGE_STATE", "Conference: %s\r\nOldState: %s\r\nNewState: %s\r\n",
84                         user->conference->name,
85                         user->conference->state->name,
86                         newstate->name);
87         if (user->conference->state->exit) {
88                 user->conference->state->exit(user);
89         }
90         user->conference->state = newstate;
91         if (user->conference->state->entry) {
92                 user->conference->state->entry(user);
93         }
94 }