summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorRichard Mudgett <rmudgett@digium.com>2013-01-21 20:15:57 +0000
committerRichard Mudgett <rmudgett@digium.com>2013-01-21 20:15:57 +0000
commitc6e6b7f2f12c1fe918aa052a19ac1bbeb4b63b3a (patch)
treec041a73341548e9aec20195ea78aaa00e797e3ce /include
parent8e3815a8ee9db8d7750223626c393f1a96e4ff3a (diff)
Made some bridging API calls void. Some bridging comments updated.
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@379753 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include')
-rw-r--r--include/asterisk/bridging.h6
-rw-r--r--include/asterisk/bridging_features.h15
2 files changed, 9 insertions, 12 deletions
diff --git a/include/asterisk/bridging.h b/include/asterisk/bridging.h
index 2d0d74b82..e4dd5cdd9 100644
--- a/include/asterisk/bridging.h
+++ b/include/asterisk/bridging.h
@@ -85,13 +85,13 @@ enum ast_bridge_capability {
/*! \brief State information about a bridged channel */
enum ast_bridge_channel_state {
- /*! Waiting for a signal */
+ /*! Waiting for a signal (Channel in the bridge) */
AST_BRIDGE_CHANNEL_STATE_WAIT = 0,
/*! Bridged channel has ended itself (it has hung up) */
AST_BRIDGE_CHANNEL_STATE_END,
- /*! Bridged channel should be hung up */
+ /*! Bridged channel was forced out and should be hung up */
AST_BRIDGE_CHANNEL_STATE_HANGUP,
- /*! Bridged channel should be removed from the bridge without being hung up */
+ /*! Bridged channel was ast_bridge_depart() from the bridge without being hung up */
AST_BRIDGE_CHANNEL_STATE_DEPART,
/*! Bridged channel is executing a feature hook */
AST_BRIDGE_CHANNEL_STATE_FEATURE,
diff --git a/include/asterisk/bridging_features.h b/include/asterisk/bridging_features.h
index a9e587505..1323a6da9 100644
--- a/include/asterisk/bridging_features.h
+++ b/include/asterisk/bridging_features.h
@@ -243,10 +243,9 @@ int ast_bridge_features_hook(struct ast_bridge_features *features,
* \param pvt_data Optional unique data that will be passed with the talking events.
* \param talker_destructor Optional destructor callback for pvt data.
*
- * \retval 0, success
- * \retval -1, failure
+ * \return Nothing
*/
-int ast_bridge_features_set_talk_detector(struct ast_bridge_features *features,
+void ast_bridge_features_set_talk_detector(struct ast_bridge_features *features,
ast_bridge_talking_indicate_callback talker_cb,
ast_bridge_talking_indicate_destructor talker_destructor,
void *pvt_data);
@@ -282,8 +281,7 @@ int ast_bridge_features_enable(struct ast_bridge_features *features, enum ast_br
* \param features Bridge features structure
* \param flag Flag to enable
*
- * \retval 0 on success
- * \retval -1 on failure
+ * \return Nothing
*
* Example usage:
*
@@ -296,7 +294,7 @@ int ast_bridge_features_enable(struct ast_bridge_features *features, enum ast_br
* This sets the AST_BRIDGE_FLAG_DISSOLVE feature to be enabled on the features structure
* 'features'.
*/
-int ast_bridge_features_set_flag(struct ast_bridge_features *features, enum ast_bridge_feature_flags flag);
+void ast_bridge_features_set_flag(struct ast_bridge_features *features, enum ast_bridge_feature_flags flag);
/*!
* \brief Initialize bridge features structure
@@ -325,8 +323,7 @@ int ast_bridge_features_init(struct ast_bridge_features *features);
*
* \param features Bridge features structure
*
- * \retval 0 on success
- * \retval -1 on failure
+ * \return Nothing
*
* Example usage:
*
@@ -341,7 +338,7 @@ int ast_bridge_features_init(struct ast_bridge_features *features);
* \note This MUST be called after the features structure is done being used
* or a memory leak may occur.
*/
-int ast_bridge_features_cleanup(struct ast_bridge_features *features);
+void ast_bridge_features_cleanup(struct ast_bridge_features *features);
/*!
* \brief Play a DTMF stream into a bridge, optionally not to a given channel