1108c88d7ae04477e482cd7701816bd0ba385f00
[asterisk/asterisk.git] / include / asterisk / bridge_channel_internal.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013 Digium, Inc.
5  *
6  * Matt Jordan <mjordan@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_PRIVATE_BRIDGING_CHANNEL_H
20 #define _ASTERISK_PRIVATE_BRIDGING_CHANNEL_H
21
22 /*!
23  * \file
24  * \brief Private Bridging Channel API
25  *
26  * \author Matt Jordan <mjordan@digium.com>
27  *
28  * A private API to manipulate channels in a bridge. These can be called on a channel in
29  * a bridge by \ref bridge.c. These functions should not be called elsewhere, including
30  * by other members of the Bridging API.
31  *
32  * See Also:
33  * \arg \ref AstCREDITS
34  * \arg \ref Ast
35  */
36
37 /*!
38  * \internal
39  * \brief Actions that can be taken on a channel in a bridge
40  */
41 enum bridge_channel_action_type {
42         /*! Bridged channel is to send a DTMF stream out */
43         BRIDGE_CHANNEL_ACTION_DTMF_STREAM,
44         /*! Bridged channel is to indicate talking start */
45         BRIDGE_CHANNEL_ACTION_TALKING_START,
46         /*! Bridged channel is to indicate talking stop */
47         BRIDGE_CHANNEL_ACTION_TALKING_STOP,
48         /*! Bridge channel is to play the indicated sound file. */
49         BRIDGE_CHANNEL_ACTION_PLAY_FILE,
50         /*! Bridge channel is to run the indicated application. */
51         BRIDGE_CHANNEL_ACTION_RUN_APP,
52         /*! Bridge channel is to run the custom callback routine. */
53         BRIDGE_CHANNEL_ACTION_CALLBACK,
54         /*! Bridge channel is to get parked. */
55         BRIDGE_CHANNEL_ACTION_PARK,
56         /*! Bridge channel is to execute a blind transfer. */
57         BRIDGE_CHANNEL_ACTION_BLIND_TRANSFER,
58         /*! Bridge channel is to execute an attended transfer */
59         BRIDGE_CHANNEL_ACTION_ATTENDED_TRANSFER,
60
61         /*
62          * Bridge actions put after this comment must never be put onto
63          * the bridge_channel wr_queue because they have other resources
64          * that must be freed.
65          */
66
67         /*! Bridge reconfiguration deferred technology destruction. */
68         BRIDGE_CHANNEL_ACTION_DEFERRED_TECH_DESTROY = 1000,
69         /*! Bridge deferred dissolving. */
70         BRIDGE_CHANNEL_ACTION_DEFERRED_DISSOLVING,
71 };
72
73 /*!
74  * \internal
75  * \brief Allocate a new ao2 ref counted bridge_channel
76  * \since 12.0.0
77  *
78  * \param bridge The bridge to make the bridge_channel for
79  *
80  * \retval NULL on error
81  * \retval ao2 ref counted object on success
82  */
83 struct ast_bridge_channel *bridge_channel_internal_alloc(struct ast_bridge *bridge);
84
85 /*!
86  * \internal
87  * \brief Push the bridge channel into its specified bridge.
88  * \since 12.0.0
89  *
90  * \param bridge_channel Channel to push.
91  *
92  * \note On entry, bridge_channel->bridge is already locked.
93  *
94  * \retval 0 on success.
95  * \retval -1 on failure.  The channel did not get pushed.
96  */
97 int bridge_channel_internal_push(struct ast_bridge_channel *bridge_channel);
98
99 /*!
100  * \internal
101  * \brief Pull the bridge channel out of its current bridge.
102  * \since 12.0.0
103  *
104  * \param bridge_channel Channel to pull.
105  *
106  * \note On entry, bridge_channel->bridge is already locked.
107  *
108  * \return Nothing
109  */
110 void bridge_channel_internal_pull(struct ast_bridge_channel *bridge_channel);
111
112 /*!
113  * \internal
114  * \brief Join the bridge_channel to the bridge
115  *
116  * \param bridge_channel The Channel in the bridge
117  *
118  * \retval 0 bridge channel successfully joined the bridge
119  * \retval -1 bridge channel failed to join the bridge
120  *
121  * \note This API call starts the bridge_channel's processing of events while
122  * it is in the bridge. It will return when the channel has been instructed to
123  * leave the bridge.
124  */
125 int bridge_channel_internal_join(struct ast_bridge_channel *bridge_channel);
126
127 /*!
128  * \internal
129  * \brief Temporarily suspend a channel from a bridge, handing control over to some
130  * other system
131  *
132  * \param bridge_channel The channel in the bridge
133  * \note This function assumes that \ref bridge_channel is already locked
134  */
135 void bridge_channel_internal_suspend_nolock(struct ast_bridge_channel *bridge_channel);
136
137 /*!
138  * \internal
139  * \brief Unsuspend a channel that was previously suspended
140  *
141  * \param bridge_channel The channel in the bridge
142  * \note This function assumes that \ref bridge_channel is already locked
143  */
144 void bridge_channel_internal_unsuspend_nolock(struct ast_bridge_channel *bridge_channel);
145
146 /*!
147  * \internal
148  * \brief Queue a blind transfer action on a transferee bridge channel
149  *
150  * This is only relevant for when a blind transfer is performed on a two-party
151  * bridge. The transferee's bridge channel will have a blind transfer bridge
152  * action queued onto it, resulting in the party being redirected to a new
153  * destination
154  *
155  * \param transferee The channel to have the action queued on
156  * \param exten The destination extension for the transferee
157  * \param context The destination context for the transferee
158  * \param hook Frame hook to attach to transferee
159  *
160  * \retval 0 on success.
161  * \retval -1 on error.
162  */
163 int bridge_channel_internal_queue_blind_transfer(struct ast_channel *transferee,
164                 const char *exten, const char *context,
165                 transfer_channel_cb new_channel_cb, void *user_data);
166
167 /*!
168  * \internal
169  * \brief Queue an attended transfer action on a transferee bridge channel
170  *
171  * This is only relevant for when an attended transfer is performed on a two-party
172  * bridge. The transferee's bridge channel will have an attended transfer bridge
173  * action queued onto it.
174  *
175  * \param transferee The channel to have the action queued on
176  * \param unbridged_chan The unbridged channel who is the target of the attended
177  * transfer
178  *
179  * \retval 0 on success.
180  * \retval -1 on error.
181  */
182 int bridge_channel_internal_queue_attended_transfer(struct ast_channel *transferee,
183                 struct ast_channel *unbridged_chan);
184
185 /*!
186  * \internal
187  * \brief Return whether or not the bridge_channel would allow optimization
188  *
189  * \retval 0 if optimization is not allowed
190  * \retval non-zero if optimization is allowed
191  */
192 int bridge_channel_internal_allows_optimization(struct ast_bridge_channel *bridge_channel);
193
194 #endif /* _ASTERISK_PRIVATE_BRIDGING_H */