diff options
author | Russell Bryant <russell@russellbryant.com> | 2009-05-09 11:33:09 +0000 |
---|---|---|
committer | Russell Bryant <russell@russellbryant.com> | 2009-05-09 11:33:09 +0000 |
commit | 9c16774cc2611d6417581c7a1acc18a929574260 (patch) | |
tree | 80e29b060503e82bbf82195d306d08209df32007 /include/asterisk | |
parent | 7e350686d698056b04052c54df867db627fb3692 (diff) |
Minor documentation update for ast_event_queue().
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@193461 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk')
-rw-r--r-- | include/asterisk/event.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/include/asterisk/event.h b/include/asterisk/event.h index b9de22dd2..c2afc57ef 100644 --- a/include/asterisk/event.h +++ b/include/asterisk/event.h @@ -358,12 +358,13 @@ void ast_event_destroy(struct ast_event *event); * \param event the event to be queued * * \retval zero success - * \retval non-zero failure + * \retval non-zero failure. Note that the caller of this function is + * responsible for destroying the event in the case of a failure. * * This function queues an event to be dispatched to all of the appropriate * subscribers. This function will not block while the event is being - * dispatched because a pool of event dispatching threads handle the event - * queue. + * dispatched because the event is queued up for a dispatching thread + * to handle. */ int ast_event_queue(struct ast_event *event); |