1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
/**
* @file event_queue.h
*
* @brief Event-Queue based on linked_list_t
*
*/
/*
* 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>
#include "types.h"
#include "job.h"
/**
* @brief Event-Queue
*
* Although the event-queue is based on a linked_list_t
* all access functions are thread-save implemented
*/
typedef struct event_queue_s event_queue_t;
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
* @returns SUCCESS if succeeded, FAILED otherwise
*/
status_t (*get_count) (event_queue_t *event_queue, int *count);
/**
* @brief get the next job from the event-queue
*
* If no event is pending, this function blocks until a job can be returned.
*
* @param event_queue calling object
* @param[out] job pointer to a job pointer where to job is returned to
* @returns SUCCESS if succeeded, FAILED otherwise
*/
status_t (*get) (event_queue_t *event_queue, job_t **job);
/**
* @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
*/
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
*
* 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
*/
status_t (*add_absolute) (event_queue_t *event_queue, job_t *job, timeval_t time);
/**
* @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
*/
status_t (*destroy) (event_queue_t *event_queue);
};
/**
* @brief Creates an empty event_queue
*
* @return empty event_queue object
*/
event_queue_t *event_queue_create();
#endif /*EVENT_QUEUE_H_*/
|
