diff options
author | Mark Michelson <mmichelson@digium.com> | 2012-12-11 04:23:31 +0000 |
---|---|---|
committer | Mark Michelson <mmichelson@digium.com> | 2012-12-11 04:23:31 +0000 |
commit | 29fc1227839155658ca899cdfa179673c88e1ee2 (patch) | |
tree | d6a3094180d98cb2b0dafe195ac66ba25a99c3f7 /include/asterisk | |
parent | 605dcfad9779c59540d9711a5dbc42d138b3949d (diff) |
Some documentation fixes and function call name fixes.
The documentation for taskprocessors was incorrect with
regards to when a listener's alloc callback was called.
I also made the names of queued function calls in the
threadpool more uniform.
git-svn-id: https://origsvn.digium.com/svn/asterisk/team/mmichelson/threadpool@377802 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk')
-rw-r--r-- | include/asterisk/taskprocessor.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/include/asterisk/taskprocessor.h b/include/asterisk/taskprocessor.h index 4f61939f8..dc110e2e5 100644 --- a/include/asterisk/taskprocessor.h +++ b/include/asterisk/taskprocessor.h @@ -77,6 +77,7 @@ struct ast_taskprocessor_listener_callbacks { /*! * \brief Allocate the listener's private data * + * This is called during taskprocesor creation. * It is not necessary to assign the private data to the listener. * * \param listener The listener to which the private data belongs @@ -150,9 +151,7 @@ struct ast_taskprocessor_listener { * Allocate a taskprocessor listener * * This will result in the listener being allocated with the specified - * callbacks. The listener's alloc() callback will be called to allocate - * private data for the listener. The private data will be assigned to the - * listener when the listener's alloc() function returns. + * callbacks. * * \param callbacks The callbacks to assign to the listener * \retval NULL Failure @@ -177,6 +176,8 @@ struct ast_taskprocessor *ast_taskprocessor_get(const char *name, enum ast_tps_o /*! * \brief Create a taskprocessor with a custom listener * + * The listener's alloc() and start() callbacks will be called during this function. + * * \param name The name of the taskprocessor to create * \param listener The listener for operations on this taskprocessor * \retval NULL Failure |