Add doxygen to accessors and increase refcount of taskprocessor before returning.

git-svn-id: https://origsvn.digium.com/svn/asterisk/team/mmichelson/threadpool@379127 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Mark Michelson
2013-01-15 21:15:04 +00:00
parent 967e380ba8
commit a73d6e5b86
3 changed files with 21 additions and 0 deletions

View File

@@ -111,7 +111,22 @@ struct ast_taskprocessor_listener_callbacks {
void (*shutdown)(struct ast_taskprocessor_listener *listener);
};
/*!
* \brief Get a reference to the listener's taskprocessor
*
* This will return the taskprocessor with its reference count increased. Release
* the reference to this object by using ast_taskprocessor_unreference()
*
* \param listener The listener that has the taskprocessor
* \return The taskprocessor
*/
struct ast_taskprocessor *ast_taskprocessor_listener_get_tps(const struct ast_taskprocessor_listener *listener);
/*!
* \brief Get the user data from the listener
* \param listener The taskprocessor listener
* \return The listener's user data
*/
void *ast_taskprocessor_listener_get_user_data(const struct ast_taskprocessor_listener *listener);
/*!

View File

@@ -114,6 +114,11 @@ struct ast_threadpool_options {
struct ast_threadpool_listener *ast_threadpool_listener_alloc(
const struct ast_threadpool_listener_callbacks *callbacks, void *user_data);
/*!
* \brief Get the threadpool listener's user data
* \param listener The threadpool listener
* \return The user data
*/
void *ast_threadpool_listener_get_user_data(const struct ast_threadpool_listener *listener);
/*!

View File

@@ -495,6 +495,7 @@ struct ast_taskprocessor_listener *ast_taskprocessor_listener_alloc(const struct
struct ast_taskprocessor *ast_taskprocessor_listener_get_tps(const struct ast_taskprocessor_listener *listener)
{
ao2_ref(listener->tps, +1);
return listener->tps;
}