summaryrefslogtreecommitdiff
path: root/include/asterisk/channel.h
diff options
context:
space:
mode:
authorGeorge Joseph <gjoseph@digium.com>2016-11-16 17:43:46 -0600
committerGerrit Code Review <gerrit2@gerrit.digium.api>2016-11-16 17:43:46 -0600
commitac0a1ee6da03f729413160e31a0fbfa79ea6cb1d (patch)
treecb1cf5fa909c75d3c9482406689c27df96614540 /include/asterisk/channel.h
parentd0474f632208e7bc160c0d04fc65d8d5e6b6c7e3 (diff)
parent2966fa5ad770710ca1d0ca7f306def6792255bd9 (diff)
Merge "Revert "Revert "Add API for channel frame deferral."""
Diffstat (limited to 'include/asterisk/channel.h')
-rw-r--r--include/asterisk/channel.h38
1 files changed, 38 insertions, 0 deletions
diff --git a/include/asterisk/channel.h b/include/asterisk/channel.h
index cfd8384cb..300196648 100644
--- a/include/asterisk/channel.h
+++ b/include/asterisk/channel.h
@@ -967,6 +967,11 @@ enum {
* The channel is executing a subroutine or macro
*/
AST_FLAG_SUBROUTINE_EXEC = (1 << 27),
+ /*!
+ * The channel is currently in an operation where
+ * frames should be deferred.
+ */
+ AST_FLAG_DEFER_FRAMES = (1 << 28),
};
/*! \brief ast_bridge_config flags */
@@ -4701,4 +4706,37 @@ enum ast_channel_error {
*/
enum ast_channel_error ast_channel_errno(void);
+/*!
+ * \brief Retrieve the deferred read queue.
+ */
+struct ast_readq_list *ast_channel_deferred_readq(struct ast_channel *chan);
+
+/*!
+ * \brief Start deferring deferrable frames on this channel
+ *
+ * Sometimes, a channel gets entered into a mode where a "main" application
+ * is tasked with servicing frames on the channel, but that application does
+ * not need to act on those frames. However, it would be imprudent to simply
+ * drop important frames. This function can be called so that important frames
+ * will be deferred, rather than placed in the channel frame queue as normal.
+ *
+ * \pre chan MUST be locked before calling
+ *
+ * \param chan The channel on which frames should be deferred
+ */
+void ast_channel_start_defer_frames(struct ast_channel *chan);
+
+/*!
+ * \brief Stop deferring deferrable frames on this channel
+ *
+ * When it is time to stop deferring frames on the channel, all deferred frames
+ * will be queued onto the channel's read queue so that the next servicer of
+ * the channel can handle those frames as necessary.
+ *
+ * \pre chan MUST be locked before calling
+ *
+ * \param chan The channel on which to stop deferring frames.
+ */
+void ast_channel_stop_defer_frames(struct ast_channel *chan);
+
#endif /* _ASTERISK_CHANNEL_H */