diff options
Diffstat (limited to 'Source/charon/event_queue.h')
| -rw-r--r-- | Source/charon/event_queue.h | 41 |
1 files changed, 23 insertions, 18 deletions
diff --git a/Source/charon/event_queue.h b/Source/charon/event_queue.h index 32e483bae..c517fcdfb 100644 --- a/Source/charon/event_queue.h +++ b/Source/charon/event_queue.h @@ -41,14 +41,13 @@ struct event_queue_s { /** * @brief Returns number of events in queue. * - * @param event_queue calling object - * @param[out] count integer pointer to store the event count in - * @return number of events in queue + * @param event_queue calling object + * @return number of events in queue */ int (*get_count) (event_queue_t *event_queue); /** - * @brief get the next job from the event-queue + * @brief Get the next job from the event-queue. * * If no event is pending, this function blocks until a job can be returned. * @@ -60,42 +59,46 @@ struct event_queue_s { status_t (*get) (event_queue_t *event_queue, job_t **job); /** - * @brief adds a event to the queue, using a relative time + * @brief Adds a event to the queue, using a relative time. * * This function is non blocking and adds a job_t at a specific time to the list. * The specific job-object has to get destroyed by the thread which * removes the job. * - * @param event_queue calling object - * @param[in] job job to add to the queue (job is not copied) - * @param[in] time time, when the event has to get fired - * @returns SUCCESS if succeeded, FAILED otherwise + * @param event_queue calling object + * @param[in] job job to add to the queue (job is not copied) + * @param[in] time relative time, when the event has to get fired + * @returns + * - SUCCESS if succeeded + * - FAILED otherwise */ status_t (*add_relative) (event_queue_t *event_queue, job_t *job, u_int32_t ms); /** - * @brief adds a event to the queue, using an absolute time + * @brief Adds a event to the queue, using an absolute time. * * This function is non blocking and adds a job_t at a specific time to the list. * The specific job-object has to get destroyed by the thread which * removes the job. * - * @param event_queue calling object - * @param[in] job job to add to the queue (job is not copied) - * @param[in] time time, when the event has to get fired - * @returns SUCCESS if succeeded, FAILED otherwise + * @param event_queue calling object + * @param[in] job job to add to the queue (job is not copied) + * @param[in] absolute time time, when the event has to get fired + * @returns + * - SUCCESS if succeeded + * - FAILED otherwise */ status_t (*add_absolute) (event_queue_t *event_queue, job_t *job, timeval_t time); /** - * @brief destroys a event_queue object + * @brief Destroys a event_queue object. * * @warning The caller of this function has to make sure * that no thread is going to add or get an event from the event_queue * after calling this function. * - * @param event_queue calling object - * @returns SUCCESS if succeeded, FAILED otherwise + * @param event_queue calling object + * @returns always SUCCESS */ status_t (*destroy) (event_queue_t *event_queue); }; @@ -103,7 +106,9 @@ struct event_queue_s { /** * @brief Creates an empty event_queue * - * @return empty event_queue object + * @returns + * - Empty event_queue_t object + * - NULL if memory allocation failed */ event_queue_t *event_queue_create(); #endif /*EVENT_QUEUE_H_*/ |