kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-09 06:28:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added a doxygen group for Stasis messages and topics

Browse Source 
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@384201 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
David M. Lee
2013-03-27 21:52:43 +00:00
parent 72bccf69c3
commit c67a06a2ff
3 changed files with 58 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
include/asterisk/channel.h
View File

@@ -4104,6 +4104,31 @@ void ast_channel_dialed_causes_clear(const struct ast_channel *chan);
struct ast_flags *ast_channel_flags(struct ast_channel *chan);
/*!
* \since 12
* \brief Sets the variables to be stored in the \a manager_vars field of all
* snapshots.
* \param varc Number of variable names.
* \param vars Array of variable names.
*/
void ast_channel_set_manager_vars(size_t varc, char **vars);
/*!
* \since 12
* \brief Gets the variables for a given channel, as specified by ast_channel_set_manager_vars().
*
* The returned variable list is an AO2 object, so ao2_cleanup() to free it.
*
* \param chan Channel to get variables for.
* \return List of channel variables.
* \return \c NULL on error
*/
struct varshead *ast_channel_get_manager_vars(struct ast_channel *chan);
/*! \addtogroup StasisTopicsAndMessages
* @{
*/
/*!
* \since 12
* \brief Structure representing a snapshot of channel state.
@@ -4155,27 +4180,6 @@ struct ast_channel_snapshot {
*/
struct ast_channel_snapshot *ast_channel_snapshot_create(struct ast_channel *chan);
/*!
* \since 12
* \brief Sets the variables to be stored in the \a manager_vars field of all
* snapshots.
* \param varc Number of variable names.
* \param vars Array of variable names.
*/
void ast_channel_set_manager_vars(size_t varc, char **vars);
/*!
* \since 12
* \brief Gets the variables for a given channel, as specified by ast_channel_set_manager_vars().
*
* The returned variable list is an AO2 object, so ao2_cleanup() to free it.
*
* \param chan Channel to get variables for.
* \return List of channel variables.
* \return \c NULL on error
*/
struct varshead *ast_channel_get_manager_vars(struct ast_channel *chan);
/*!
* \since 12
* \brief Message type for \ref ast_channel_snapshot.
@@ -4261,6 +4265,8 @@ const char *ast_channel_blob_type(struct ast_channel_blob *obj);
struct stasis_message *ast_channel_blob_create(struct ast_channel *chan,
struct ast_json *blob);
/*! @} */
/*!
* \since 12
* \brief Publish a \ref ast_channel_varset for a channel.