2005-11-04 13:21:25 +00:00
|
|
|
/**
|
|
|
|
* @file event_queue.h
|
2005-11-10 09:35:28 +00:00
|
|
|
*
|
2005-11-10 08:44:17 +00:00
|
|
|
* @brief Event-Queue based on class linked_list_t
|
2005-11-10 09:35:28 +00:00
|
|
|
*
|
2005-11-04 13:21:25 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Copyright (C) 2005 Jan Hutter, Martin Willi
|
|
|
|
* Hochschule fuer Technik Rapperswil
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or modify it
|
|
|
|
* under the terms of the GNU General Public License as published by the
|
|
|
|
* Free Software Foundation; either version 2 of the License, or (at your
|
|
|
|
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful, but
|
|
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
|
|
|
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
|
* for more details.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef EVENT_QUEUE_H_
|
|
|
|
#define EVENT_QUEUE_H_
|
|
|
|
|
|
|
|
#include <sys/time.h>
|
|
|
|
|
2005-11-23 09:13:40 +00:00
|
|
|
#include <types.h>
|
2005-11-23 09:34:31 +00:00
|
|
|
#include <queues/jobs/job.h>
|
2005-11-04 13:21:25 +00:00
|
|
|
|
|
|
|
/**
|
2005-11-10 08:44:17 +00:00
|
|
|
* @brief Event-Queue used to store timed events.
|
2005-11-04 13:21:25 +00:00
|
|
|
*
|
2005-11-10 09:35:28 +00:00
|
|
|
* Although the event-queue is based on a linked_list_t
|
2005-11-10 08:44:17 +00:00
|
|
|
* all access functions are thread-save implemented.
|
2005-11-04 13:21:25 +00:00
|
|
|
*/
|
|
|
|
typedef struct event_queue_s event_queue_t;
|
|
|
|
|
|
|
|
struct event_queue_s {
|
2005-11-10 09:35:28 +00:00
|
|
|
|
2005-11-04 13:21:25 +00:00
|
|
|
/**
|
2005-11-10 08:44:17 +00:00
|
|
|
* @brief Returns number of events in queue.
|
2005-11-10 09:35:28 +00:00
|
|
|
*
|
2005-11-10 08:55:47 +00:00
|
|
|
* @param event_queue calling object
|
|
|
|
* @return number of events in queue
|
2005-11-04 13:21:25 +00:00
|
|
|
*/
|
2005-11-10 08:44:17 +00:00
|
|
|
int (*get_count) (event_queue_t *event_queue);
|
2005-11-04 13:21:25 +00:00
|
|
|
|
|
|
|
/**
|
2005-11-10 08:55:47 +00:00
|
|
|
* @brief Get the next job from the event-queue.
|
2005-11-10 09:35:28 +00:00
|
|
|
*
|
2005-11-04 13:21:25 +00:00
|
|
|
* If no event is pending, this function blocks until a job can be returned.
|
2005-11-10 09:35:28 +00:00
|
|
|
*
|
2005-11-10 08:44:17 +00:00
|
|
|
* @param event_queue calling object
|
|
|
|
* @param[out] job pointer to a job pointer where to job is returned to
|
|
|
|
* @return - SUCCESS if succeeded
|
|
|
|
* - FAILED otherwisesa
|
2005-11-04 13:21:25 +00:00
|
|
|
*/
|
|
|
|
status_t (*get) (event_queue_t *event_queue, job_t **job);
|
2005-11-10 09:35:28 +00:00
|
|
|
|
2005-11-04 13:21:25 +00:00
|
|
|
/**
|
2005-11-10 08:55:47 +00:00
|
|
|
* @brief Adds a event to the queue, using a relative time.
|
2005-11-10 09:35:28 +00:00
|
|
|
*
|
2005-11-04 13:21:25 +00:00
|
|
|
* This function is non blocking and adds a job_t at a specific time to the list.
|
2005-11-10 09:35:28 +00:00
|
|
|
* The specific job object has to get destroyed by the thread which
|
2005-11-04 13:21:25 +00:00
|
|
|
* removes the job.
|
2005-11-10 09:35:28 +00:00
|
|
|
*
|
2005-11-10 08:55:47 +00:00
|
|
|
* @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
|
2005-11-10 09:35:28 +00:00
|
|
|
* @returns
|
2005-11-10 08:55:47 +00:00
|
|
|
* - SUCCESS if succeeded
|
|
|
|
* - FAILED otherwise
|
2005-11-04 13:21:25 +00:00
|
|
|
*/
|
2005-11-07 15:54:24 +00:00
|
|
|
status_t (*add_relative) (event_queue_t *event_queue, job_t *job, u_int32_t ms);
|
2005-11-10 09:35:28 +00:00
|
|
|
|
2005-11-07 15:54:24 +00:00
|
|
|
/**
|
2005-11-10 08:55:47 +00:00
|
|
|
* @brief Adds a event to the queue, using an absolute time.
|
2005-11-10 09:35:28 +00:00
|
|
|
*
|
2005-11-07 15:54:24 +00:00
|
|
|
* This function is non blocking and adds a job_t at a specific time to the list.
|
2005-11-10 09:35:28 +00:00
|
|
|
* The specific job object has to get destroyed by the thread which
|
2005-11-07 15:54:24 +00:00
|
|
|
* removes the job.
|
2005-11-10 09:35:28 +00:00
|
|
|
*
|
2005-11-10 08:55:47 +00:00
|
|
|
* @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
|
2005-11-07 15:54:24 +00:00
|
|
|
*/
|
|
|
|
status_t (*add_absolute) (event_queue_t *event_queue, job_t *job, timeval_t time);
|
2005-11-04 13:21:25 +00:00
|
|
|
|
|
|
|
/**
|
2005-11-10 08:55:47 +00:00
|
|
|
* @brief Destroys a event_queue object.
|
2005-11-10 09:35:28 +00:00
|
|
|
*
|
2005-11-04 13:21:25 +00:00
|
|
|
* @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.
|
2005-11-10 09:35:28 +00:00
|
|
|
*
|
2005-11-10 08:55:47 +00:00
|
|
|
* @param event_queue calling object
|
|
|
|
* @returns always SUCCESS
|
2005-11-04 13:21:25 +00:00
|
|
|
*/
|
|
|
|
status_t (*destroy) (event_queue_t *event_queue);
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Creates an empty event_queue
|
2005-11-10 09:35:28 +00:00
|
|
|
*
|
|
|
|
* @returns
|
2005-11-10 08:55:47 +00:00
|
|
|
* - Empty event_queue_t object
|
|
|
|
* - NULL if memory allocation failed
|
2005-11-04 13:21:25 +00:00
|
|
|
*/
|
|
|
|
event_queue_t *event_queue_create();
|
|
|
|
#endif /*EVENT_QUEUE_H_*/
|