ARI: allow other operations to happen while bridged
[asterisk/asterisk.git] / res / stasis / control.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@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 #ifndef _ASTERISK_RES_STASIS_CONTROL_H
20 #define _ASTERISK_RES_STASIS_CONTROL_H
21
22 /*! \file
23  *
24  * \brief Internal API for the Stasis application controller.
25  *
26  * \author David M. Lee, II <dlee@digium.com>
27  * \since 12
28  */
29
30 #include "asterisk/stasis_app.h"
31
32 /*!
33  * \brief Create a control object.
34  *
35  * \param channel Channel to control.
36  * \return New control object.
37  * \return \c NULL on error.
38  */
39 struct stasis_app_control *control_create(struct ast_channel *channel);
40
41 /*!
42  * \brief Dispatch all commands enqueued to this control.
43  *
44  * \param control Control object to dispatch.
45  * \param chan Associated channel.
46  * \return Number of commands executed
47  */
48 int control_dispatch_all(struct stasis_app_control *control,
49         struct ast_channel *chan);
50
51 /*!
52  * \brief Blocks until \a control's command queue has a command available.
53  *
54  * \param control Control to block on.
55  */
56 void control_wait(struct stasis_app_control *control);
57
58 /*!
59  * \brief Signals that a control object should finish and exit back to the
60  * dialplan.
61  *
62  * \param control Control object to continue.
63  */
64 void control_continue(struct stasis_app_control *control);
65
66 /*!
67  * \brief Returns true if control_continue() has been called on this \a control.
68  *
69  * \param control Control to query.
70  * \return True (non-zero) if control_continue() has been called.
71  * \return False (zero) otherwise.
72  */
73 int control_is_done(struct stasis_app_control *control);
74
75
76 #endif /* _ASTERISK_RES_STASIS_CONTROL_H */