[asterisk-commits] file: branch file/bridging r111852 - /team/file/bridging/main/bridging.c
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Fri Mar 28 15:49:28 CDT 2008
Author: file
Date: Fri Mar 28 15:49:28 2008
New Revision: 111852
URL: http://svn.digium.com/view/asterisk?view=rev&rev=111852
Log:
Centralize all public API doxygen in the header file.
Modified:
team/file/bridging/main/bridging.c
Modified: team/file/bridging/main/bridging.c
URL: http://svn.digium.com/view/asterisk/team/file/bridging/main/bridging.c?view=diff&rev=111852&r1=111851&r2=111852
==============================================================================
--- team/file/bridging/main/bridging.c (original)
+++ team/file/bridging/main/bridging.c Fri Mar 28 15:49:28 2008
@@ -45,11 +45,6 @@
/*! Default DTMF keys for built in features */
static char builtin_features_dtmf[AST_BRIDGE_BUILTIN_END][8];
-/*! \brief Register a bridge technology for use
- * \param technology The bridge technology to register
- * \param module The module that is registering the bridge technology
- * \return Returns 0 on success, -1 on failure
- */
int __ast_bridge_technology_register(struct ast_bridge_technology *technology, struct ast_module *module)
{
struct ast_bridge_technology *current = NULL;
@@ -85,10 +80,6 @@
return 0;
}
-/*! \brief Unregister a bridge technology from use
- * \param technology The bridge technology to unregister
- * \return Returns 0 on success, -1 on failure
- */
int ast_bridge_technology_unregister(struct ast_bridge_technology *technology)
{
struct ast_bridge_technology *current = NULL;
@@ -325,10 +316,6 @@
return best;
}
-/*! \brief Create a new bridge
- * \param capabilities The capabilities that we require to be used on the bridge
- * \return Returns bridge on success, NULL on failure
- */
struct ast_bridge *ast_bridge_new(int capabilities, int flags)
{
struct ast_bridge *bridge = NULL;
@@ -367,10 +354,6 @@
return bridge;
}
-/*! \brief Destroy a bridge
- * \param bridge Bridge to destroy
- * \return Returns 0 on success, -1 on failure
- */
int ast_bridge_destroy(struct ast_bridge *bridge)
{
struct ast_bridge_channel *bridge_channel = NULL;
@@ -435,7 +418,6 @@
return 0;
}
-/*! \brief Function to make a bridged channel compatible with a bridge */
static int bridge_make_compatible(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel)
{
int formats[2] = {bridge_channel->chan->readformat, bridge_channel->chan->writeformat};
@@ -879,11 +861,6 @@
return bridge_channel->state;
}
-/*! \brief Join a channel to a bridge
- * \param bridge Bridge to join
- * \param chan Channel to join
- * \return Returns phase that channel exited bridge on
- */
enum ast_bridge_channel_state ast_bridge_join(struct ast_bridge *bridge, struct ast_channel *chan, struct ast_channel *swap, struct ast_bridge_features *features)
{
struct ast_bridge_channel bridge_channel;
@@ -1007,11 +984,6 @@
return NULL;
}
-/*! \brief Impart a channel on a bridge
- * \param bridge Bridge to impart on
- * \param chan Channel to impart
- * \return Returns 0 on success, -1 on failure
- */
int ast_bridge_impart(struct ast_bridge *bridge, struct ast_channel *chan, struct ast_channel *swap, struct ast_bridge_features *features)
{
struct ast_bridge_channel *bridge_channel = NULL;
@@ -1085,11 +1057,6 @@
return 0;
}
-/*! \brief Depart a channel from a bridge
- * \param bridge Bridge to depart from
- * \param chan Channel to depart
- * \return Returns 0 on success, -1 on failure
- */
int ast_bridge_depart(struct ast_bridge *bridge, struct ast_channel *chan)
{
struct ast_bridge_channel *bridge_channel = NULL;
@@ -1128,11 +1095,6 @@
return 0;
}
-/*! \brief Remove a channel from a bridge
- * \param bridge Bridge that the channel is to be removed from
- * \param chan Channel to remove
- * \return Returns 0 on success, -1 on failure
- */
int ast_bridge_remove(struct ast_bridge *bridge, struct ast_channel *chan)
{
struct ast_bridge_channel *bridge_channel = NULL;
@@ -1159,11 +1121,6 @@
return 0;
}
-/*! \brief Change the state of a bridge channel
- * \param bridge_channel Bridge channel
- * \param new_state State to change to
- * \return Returns 0 on success, -1 on failure
- */
int ast_bridge_change_state(struct ast_bridge_channel *bridge_channel, enum ast_bridge_channel_state new_state)
{
/* Change the state on the bridge channel */
@@ -1175,10 +1132,6 @@
return ast_cond_signal(&bridge_channel->cond);
}
-/*! \brief Request that the bridge rebuild itself
- * \param bridge Bridge in question
- * \ return Returns 0 on success, -1 on failure
- */
int ast_bridge_rebuild(struct ast_bridge *bridge)
{
/* Right now this is simple... just set an integer */
@@ -1191,11 +1144,6 @@
return ast_cond_signal(&bridge->cond);
}
-/*! \brief Merge two bridges together
- * \param bridge0 First bridge
- * \param bridge1 Second bridge
- * \return Returns 0 on success, -1 on failure
- */
int ast_bridge_merge(struct ast_bridge *bridge0, struct ast_bridge *bridge1)
{
struct ast_bridge_channel *bridge_channel = NULL;
@@ -1280,11 +1228,6 @@
return 0;
}
-/*! \brief Suspend a channel temporarily from a bridge. Control will be given to the current thread.
- * \param bridge Bridge to suspend the channel from
- * \param chan Channel to suspend
- * \param Returns 0 on success, -1 on failure
- */
int ast_bridge_suspend(struct ast_bridge *bridge, struct ast_channel *chan)
{
struct ast_bridge_channel *bridge_channel = NULL;
@@ -1312,11 +1255,6 @@
return 0;
}
-/*! \brief Unsuspend a channel from a bridge.
- * \param bridge Bridge to unsuspend the channel from
- * \param chan Channel to unsuspend
- * \param Returns 0 on success, -1 on failure
- */
int ast_bridge_unsuspend(struct ast_bridge *bridge, struct ast_channel *chan)
{
struct ast_bridge_channel *bridge_channel = NULL;
@@ -1340,31 +1278,18 @@
return 0;
}
-/*! \brief Suspend a bridge technology from consideration
- * \param technology The bridge technology to suspend
- */
void ast_bridge_technology_suspend(struct ast_bridge_technology *technology)
{
technology->suspended = 1;
return;
}
-/*! \brief Unsuspend a bridge technology
- * \param technology The bridge technology to unsuspend
- */
void ast_bridge_technology_unsuspend(struct ast_bridge_technology *technology)
{
technology->suspended = 0;
return;
}
-/*! \brief Attach a custom hook to a bridge features structure
- * \param features Bridge features structure
- * \param dtmf DTMF string to be activated upon
- * \param callback Function to execute upon activation
- * \param hook_pvt Unique data
- * \return Returns 0 on success, -1 on failure
- */
int ast_bridge_features_hook(struct ast_bridge_features *features, const char *dtmf, ast_bridge_features_hook_callback callback, void *hook_pvt)
{
struct ast_bridge_features_hook *hook = NULL;
@@ -1570,12 +1495,6 @@
return 0;
}
-/*! \brief Enable a built in feature on a bridge features structure
- * \param features Bridge features structure
- * \param feature Feature to enable
- * \param dtmf Optionally the DTMF stream to trigger the feature, if not specified it will be the default
- * \return Returns 0 on success, -1 on failure
- */
int ast_bridge_features_enable(struct ast_bridge_features *features, enum ast_bridge_builtin_feature feature, const char *dtmf)
{
ast_bridge_features_hook_callback callback = NULL;
@@ -1602,11 +1521,6 @@
return ast_bridge_features_hook(features, dtmf, callback, NULL);
}
-/*! \brief Set a flag on a bridge features structure
- * \param features Bridge features structure
- * \param flag Flag to enable
- * \return Returns 0 on success, -1 on failure
- */
int ast_bridge_features_set_flag(struct ast_bridge_features *features, int flag)
{
ast_set_flag(&features->feature_flags, flag);
@@ -1614,10 +1528,6 @@
return 0;
}
-/*! \brief Initialize bridge features structure
- * \param features Bridge featues structure
- * \return Returns 0 on success, -1 on failure
- */
int ast_bridge_features_init(struct ast_bridge_features *features)
{
/* Zero out the structure */
@@ -1629,10 +1539,6 @@
return 0;
}
-/*! \brief Clean up the contents of a bridge features structure
- * \param features Bridge features structure
- * \return Returns 0 on success, -1 on failure
- */
int ast_bridge_features_cleanup(struct ast_bridge_features *features)
{
struct ast_bridge_features_hook *hook = NULL;
@@ -1644,12 +1550,6 @@
return 0;
}
-/*! \brief Play a DTMF stream into a bridge, optionally not to a given channel
- * \param bridge Bridge to play stream into
- * \param dtmf DTMF to play
- * \param chan Channel to optionally not play to
- * \return Returns 0 on success, -1 on failure
- */
int ast_bridge_dtmf_stream(struct ast_bridge *bridge, const char *dtmf, struct ast_channel *chan)
{
struct ast_bridge_channel *bridge_channel = NULL;
More information about the asterisk-commits
mailing list