Add doxygen to accessors and increase refcount of taskprocessor before returning.
authorMark Michelson <mmichelson@digium.com>
Tue, 15 Jan 2013 21:15:04 +0000 (21:15 +0000)
committerMark Michelson <mmichelson@digium.com>
Tue, 15 Jan 2013 21:15:04 +0000 (21:15 +0000)
git-svn-id: https://origsvn.digium.com/svn/asterisk/team/mmichelson/threadpool@379127 65c4cc65-6c06-0410-ace0-fbb531ad65f3

include/asterisk/taskprocessor.h
include/asterisk/threadpool.h
main/taskprocessor.c

index a26cf43..708b3d7 100644 (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);
 
 /*!
index 51abc63..04daa9f 100644 (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);
 
 /*!
index 0b6a2a8..b603e57 100644 (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;
 }