Skip to content

Commit

Permalink
Add note about freeing transaction in handle_message (#3374)
Browse files Browse the repository at this point in the history
  • Loading branch information
vincentfretin authored May 24, 2024
1 parent 0375089 commit 82efb6f
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions src/plugins/plugin.h
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,10 @@ struct janus_plugin {
* @param[out] error An integer that may contain information about any error */
void (* const create_session)(janus_plugin_session *handle, int *error);
/*! \brief Method to handle an incoming message/request from a peer
* @note The Janus core leaves ownership of both the \c message and \c jsep
* json_t objects to plugins. This means that you'll have to decrease your own
* reference yourself with a \c json_decref when you're done with them.
* You'll also have to free \c transaction with \c g_free
* @param[in] handle The plugin/gateway session used for this peer
* @param[in] transaction The transaction identifier for this message/request
* @param[in] message The json_t object containing the message/request JSON
Expand Down Expand Up @@ -354,9 +358,9 @@ struct janus_plugin {
/*! \brief Callbacks to contact the Janus core */
struct janus_callbacks {
/*! \brief Callback to push events/messages to a peer
* @note The Janus core increases the references to both the message and jsep
* @note The Janus core increases the references to both the \c message and \c jsep
* json_t objects. This means that you'll have to decrease your own
* reference yourself with a \c json_decref after calling push_event.
* reference yourself with a \c json_decref after calling \c push_event
* @param[in] handle The plugin/gateway session used for this peer
* @param[in] plugin The plugin instance that is sending the message/event
* @param[in] transaction The transaction identifier this message refers to
Expand Down

0 comments on commit 82efb6f

Please sign in to comment.