Asterisk - The Open Source Telephony Project  GIT-master-09303e8
conf_state.h
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  * 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  * See https://wiki.asterisk.org/wiki/display/AST/Confbridge+state+changes for
29  * a more complete description of how conference states work.
30  */
31 
32 /*** MODULEINFO
33  <support_level>core</support_level>
34  ***/
35 
36 #ifndef _CONF_STATE_H_
37 #define _CONF_STATE_H_
38 
39 struct confbridge_state;
41 struct confbridge_user;
42 
43 typedef void (*conference_event_fn)(struct confbridge_user *user);
44 typedef void (*conference_entry_fn)(struct confbridge_user *user);
45 typedef void (*conference_exit_fn)(struct confbridge_user *user);
46 
47 /*! \brief A conference state object to hold the various state callback functions */
49  const char *name;
50  conference_event_fn join_unmarked; /*!< Handle an unmarked join event */
51  conference_event_fn join_waitmarked; /*!< Handle a waitmarked join event */
52  conference_event_fn join_marked; /*!< Handle a marked join event */
53  conference_event_fn leave_unmarked; /*!< Handle an unmarked leave event */
54  conference_event_fn leave_waitmarked; /*!< Handle a waitmarked leave event */
55  conference_event_fn leave_marked; /*!< Handle a marked leave event */
56  conference_entry_fn entry; /*!< Function to handle entry to a state */
57  conference_exit_fn exit; /*!< Function to handle exiting from a state */
58 };
59 
60 /*! \brief Conference state with no active or waiting users */
61 extern struct confbridge_state *CONF_STATE_EMPTY;
62 
63 /*! \brief Conference state with only waiting users */
65 
66 /*! \brief Conference state with only a single unmarked active user */
67 extern struct confbridge_state *CONF_STATE_SINGLE;
68 
69 /*! \brief Conference state with only a single marked active user */
71 
72 /*! \brief Conference state with multiple active users, but no marked users */
73 extern struct confbridge_state *CONF_STATE_MULTI;
74 
75 /*! \brief Conference state with multiple active users and at least one marked user */
77 
78 /*! \brief Execute conference state transition because of a user action
79  * \param user The user that joined/left
80  * \param newstate The state to transition to
81  */
82 void conf_change_state(struct confbridge_user *user, struct confbridge_state *newstate);
83 
84 /* Common event handlers shared between different states */
85 
86 /*! \brief Logic to execute every time a waitmarked user joins an unmarked conference */
88 
89 /*! \brief Logic to execute every time a waitmarked user leaves an unmarked conference */
91 
92 /*! \brief A handler for join/leave events that are invalid in a particular state */
94 
95 #endif
static char user[512]
struct confbridge_state * CONF_STATE_EMPTY
Conference state with no active or waiting users.
conference_event_fn join_unmarked
Definition: conf_state.h:50
struct confbridge_state * CONF_STATE_INACTIVE
Conference state with only waiting users.
const char * name
Definition: conf_state.h:49
void(* conference_entry_fn)(struct confbridge_user *user)
Definition: conf_state.h:44
conference_event_fn leave_unmarked
Definition: conf_state.h:53
conference_event_fn join_marked
Definition: conf_state.h:52
struct confbridge_state * CONF_STATE_MULTI_MARKED
Conference state with multiple active users and at least one marked user.
conference_event_fn leave_marked
Definition: conf_state.h:55
struct confbridge_state * CONF_STATE_SINGLE_MARKED
Conference state with only a single marked active user.
conference_entry_fn entry
Definition: conf_state.h:56
struct confbridge_state * CONF_STATE_MULTI
Conference state with multiple active users, but no marked users.
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:45
void(* conference_exit_fn)(struct confbridge_user *user)
Definition: conf_state.h:45
conference_event_fn join_waitmarked
Definition: conf_state.h:51
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:74
The structure that represents a conference bridge.
Definition: confbridge.h:243
structure to hold users read from users.conf
A conference state object to hold the various state callback functions.
Definition: conf_state.h:48
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:82
conference_event_fn leave_waitmarked
Definition: conf_state.h:54
The structure that represents a conference bridge user.
Definition: confbridge.h:270
struct confbridge_state * CONF_STATE_SINGLE
Conference state with only a single unmarked active user.
void(* conference_event_fn)(struct confbridge_user *user)
Definition: conf_state.h:43
conference_exit_fn exit
Definition: conf_state.h:57
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:67