Updated retry timer mechanism to incorporate smoothed RTT estimation.
[gpxe.git] / src / include / gpxe / retry.h
1 #ifndef _GPXE_RETRY_H
2 #define _GPXE_RETRY_H
3
4 /** @file
5  *
6  * Retry timers
7  *
8  */
9
10 #include <gpxe/list.h>
11
12 /** A retry timer */
13 struct retry_timer {
14         /** List of active timers */
15         struct list_head list;
16         /** Timeout value (in ticks) */
17         unsigned long timeout;
18         /** Start time (in ticks) */
19         unsigned long start;
20         /** Timer expired callback
21          *
22          * @v timer     Retry timer
23          * @v fail      Failure indicator
24          *
25          * The timer will already be stopped when this method is
26          * called.  The failure indicator will be True if the retry
27          * timeout has already exceeded @c MAX_TIMEOUT.
28          */
29         void ( * expired ) ( struct retry_timer *timer, int over );
30 };
31
32 extern void start_timer ( struct retry_timer *timer );
33 extern void stop_timer ( struct retry_timer *timer );
34
35 #endif /* _GPXE_RETRY_H */