blob: a139f82e4303cd7aaf005de91d86cf7300f3f855 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2013, Digium, Inc.
*
* David M. Lee, II <dlee@digium.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
#ifndef _ASTERISK_RES_STASIS_CONTROL_H
#define _ASTERISK_RES_STASIS_CONTROL_H
/*! \file
*
* \brief Internal API for the Stasis application controller.
*
* \author David M. Lee, II <dlee@digium.com>
* \since 12
*/
#include "asterisk/stasis_app.h"
/*!
* \brief Create a control object.
*
* \param channel Channel to control.
* \param app stasis_app for which this control is being created.
*
* \return New control object.
* \return \c NULL on error.
*/
struct stasis_app_control *control_create(struct ast_channel *channel, struct stasis_app *app);
/*!
* \brief Dispatch all commands enqueued to this control.
*
* \param control Control object to dispatch.
* \param chan Associated channel.
* \return Number of commands executed
*/
int control_dispatch_all(struct stasis_app_control *control,
struct ast_channel *chan);
/*!
* \brief Blocks until \a control's command queue has a command available.
*
* \param control Control to block on.
*/
void control_wait(struct stasis_app_control *control);
/*!
* \brief Returns the count of items in a control's command queue.
*
* \param control Control to count commands on
*
* \retval number of commands in the command que
*/
int control_command_count(struct stasis_app_control *control);
/*!
* \brief Returns true if control_continue() has been called on this \a control.
*
* \param control Control to query.
* \return True (non-zero) if control_continue() has been called.
* \return False (zero) otherwise.
*/
int control_is_done(struct stasis_app_control *control);
void control_mark_done(struct stasis_app_control *control);
/*!
* \brief Dispatch all queued prestart commands
*
* \param control The control for chan
* \param channel The channel on which commands should be executed
*
* \return The number of commands executed
*/
int control_prestart_dispatch_all(struct stasis_app_control *control,
struct ast_channel *chan);
/*!
* \brief Returns the pointer (non-reffed) to the app associated with this control
*
* \param control Control to query.
*
* \returns A pointer to the associated stasis_app
*/
struct stasis_app *control_app(struct stasis_app_control *control);
/*!
* \brief Command callback for adding a channel to a bridge
*
* \param control The control for chan
* \param channel The channel on which commands should be executed
* \param bridge Data to be passed to the callback
*/
int control_add_channel_to_bridge(
struct stasis_app_control *control,
struct ast_channel *chan, void *obj);
#endif /* _ASTERISK_RES_STASIS_CONTROL_H */
|
