diff options
Diffstat (limited to 'include/asterisk/stasis_channels.h')
| -rw-r--r-- | include/asterisk/stasis_channels.h | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/include/asterisk/stasis_channels.h b/include/asterisk/stasis_channels.h index 519a4b676..65ea660f6 100644 --- a/include/asterisk/stasis_channels.h +++ b/include/asterisk/stasis_channels.h @@ -153,6 +153,8 @@ struct stasis_message_type *ast_channel_snapshot_type(void); * \brief Generate a snapshot of the channel state. This is an ao2 object, so * ao2_cleanup() to deallocate. * + * \pre chan is locked + * * \param chan The channel from which to generate a snapshot * * \retval pointer on success (must be unreffed) @@ -192,6 +194,8 @@ struct ast_channel_snapshot *ast_channel_snapshot_get_latest_by_name(const char * The given \a blob should be treated as immutable and not modified after it is * put into the message. * + * \pre chan is locked + * * \param chan Channel blob is associated with, or \c NULL for global/all channels. * \param type Message type for this blob. * \param blob JSON object representing the data, or \c NULL for no data. If @@ -305,6 +309,8 @@ void ast_multi_channel_blob_add_channel(struct ast_multi_channel_blob *obj, * \brief Publish a channel blob message. * \since 12.0.0 * + * \pre chan is locked + * * \param chan Channel publishing the blob. * \param type Type of stasis message. * \param blob The blob being published. (NULL if no blob) @@ -318,6 +324,8 @@ void ast_channel_publish_blob(struct ast_channel *chan, struct stasis_message_ty * \since 12 * \brief Set flag to indicate channel snapshot is being staged. * + * \pre chan is locked + * * \param chan Channel being staged. */ void ast_channel_stage_snapshot(struct ast_channel *chan); @@ -326,6 +334,8 @@ void ast_channel_stage_snapshot(struct ast_channel *chan); * \since 12 * \brief Clear flag to indicate channel snapshot is being staged, and publish snapshot. * + * \pre chan is locked + * * \param chan Channel being staged. */ void ast_channel_stage_snapshot_done(struct ast_channel *chan); @@ -334,6 +344,8 @@ void ast_channel_stage_snapshot_done(struct ast_channel *chan); * \since 12 * \brief Publish a \ref ast_channel_snapshot for a channel. * + * \pre chan is locked + * * \param chan Channel to publish. */ void ast_channel_publish_snapshot(struct ast_channel *chan); @@ -342,6 +354,8 @@ void ast_channel_publish_snapshot(struct ast_channel *chan); * \since 12 * \brief Publish a \ref ast_channel_varset for a channel. * + * \pre chan is locked + * * \param chan Channel to publish the event for, or \c NULL for 'none'. * \param variable Name of the variable being set * \param value Value. @@ -533,6 +547,8 @@ void ast_channel_publish_dial_forward(struct ast_channel *caller, * \brief Publish in the \ref ast_channel_topic a \ref ast_channel_snapshot * message indicating a change in channel state * + * \pre chan is locked + * * \param chan The channel whose state has changed */ void ast_publish_channel_state(struct ast_channel *chan); |