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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/* Quagga timers support -- header
* Copyright (C) 2009 Chris Hall (GMCH), Highwayman
*
* This file is part of GNU Zebra.
*
* GNU Zebra 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, or (at your
* option) any later version.
*
* GNU Zebra 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.
*
* You should have received a copy of the GNU General Public License
* along with GNU Zebra; see the file COPYING. If not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifndef _ZEBRA_QTIMERS_H
#define _ZEBRA_QTIMERS_H
#include <stdbool.h>
#include "zassert.h"
#include "qtime.h"
#include "heap.h"
#ifndef Inline
#define Inline static inline
#endif
/*==============================================================================
* Quagga Timers -- qtimer_xxxx
*
* Here and in qtimers.c is a data structure for managing multiple timers
* each with an action to be executed when the timer expires.
*/
/*==============================================================================
* Data Structures.
*/
typedef struct qtimer* qtimer ;
typedef struct qtimer_pile* qtimer_pile ;
typedef void (qtimer_action)(qtimer qtr, void* timer_info, qtime_mono_t when) ;
struct qtimer
{
qtimer_pile pile ; /* pile currently allocated to */
heap_backlink_t backlink ;
bool active ; /* true => in the pile */
qtime_mono_t time ; /* current time to trigger action */
qtimer_action* action ;
void* timer_info ;
qtime_t interval ; /* optional timer interval */
} ;
struct qtimer_pile
{
struct heap timers ;
qtimer implicit_unset ; /* used during dispatch */
} ;
/*==============================================================================
* Functions
*/
extern qtimer_pile qtimer_pile_init_new(qtimer_pile qtp) ;
extern bool qtimer_pile_dispatch_next(qtimer_pile qtp, qtime_mono_t upto) ;
extern qtime_t qtimer_pile_top_wait(qtimer_pile qtp, qtime_t max_wait) ;
extern qtimer qtimer_pile_ream(qtimer_pile qtp, int free_structure) ;
/* Ream out qtimer pile and free the qtimer structure. */
#define qtimer_pile_ream_free(qtp) qtimer_pile_ream(qtp, 1)
/* Ream out qtimer pile but keep the qtimer structure. */
#define qtimer_pile_ream_keep(qtp) qtimer_pile_ream(qtp, 0)
extern qtimer qtimer_init_new(qtimer qtr, qtimer_pile qtp,
qtimer_action* action, void* timer_info) ;
extern void qtimer_set_pile(qtimer qtr, qtimer_pile qtp) ;
Inline void qtimer_set_action(qtimer qtr, qtimer_action* action) ;
Inline void qtimer_set_info(qtimer qtr, void* timer_info) ;
extern qtimer qtimer_free(qtimer qtr) ;
extern void qtimer_set(qtimer qtr, qtime_mono_t when, qtimer_action* action) ;
extern void qtimer_unset(qtimer qtr) ;
Inline void qtimer_add(qtimer qtr, qtime_t interval, qtimer_action* action) ;
Inline qtime_mono_t qtimer_get(qtimer qtr) ;
Inline void qtimer_set_interval(qtimer qtr, qtime_t interval,
qtimer_action* action) ;
Inline void qtimer_add_interval(qtimer qtr, qtimer_action* action) ;
Inline qtime_t qtimer_get_interval(qtimer qtr) ;
extern void qtimer_pile_verify(qtimer_pile qtp) ;
/*==============================================================================
* Inline functions
*/
/*------------------------------------------------------------------------------
* Set given timer to given time later than *its* current time.
*/
Inline void
qtimer_add(qtimer qtr, qtime_t interval, qtimer_action* action)
{
qtimer_set(qtr, qtimer_get(qtr) + interval, action);
} ;
/*------------------------------------------------------------------------------
* Get the given timer's time.
*/
Inline qtime_mono_t
qtimer_get(qtimer qtr)
{
return qtr->time ;
} ;
/*------------------------------------------------------------------------------
* Set action for given timer -- setting a NULL action unsets the timer.
*/
Inline void
qtimer_set_action(qtimer qtr, qtimer_action* action)
{
if (action == NULL)
qtimer_unset(qtr) ;
qtr->action = action ;
} ;
/*------------------------------------------------------------------------------
* Set timer_info for given timer.
*/
Inline void
qtimer_set_info(qtimer qtr, void* timer_info)
{
qtr->timer_info = timer_info ;
} ;
/* Interval handling ---------------------------------------------------------*/
/* Set the interval field
*/
Inline void
qtimer_set_interval(qtimer qtr, qtime_t interval, qtimer_action* action)
{
qtr->interval = interval ;
qtimer_set(qtr, qt_add_monotonic(interval), action) ;
} ;
Inline void
qtimer_add_interval(qtimer qtr, qtimer_action* action)
{
qtimer_add(qtr, qtr->interval, action) ;
} ;
/* Get the current value of the interval field
*/
Inline qtime_t
qtimer_get_interval(qtimer qtr)
{
return qtr->interval ;
} ;
#endif /* _ZEBRA_QTIMERS_H */
|
