iPXE
Data Fields
retry_timer Struct Reference

A retry timer. More...

#include <retry.h>

Data Fields

struct list_head list
 List of active timers.
unsigned int running
 Timer is currently running.
unsigned long timeout
 Timeout value (in ticks)
unsigned long min
 Minimum timeout value (in ticks), or zero to use default.
unsigned long max
 Maximum timeout value (in ticks), or zero to use default.
unsigned long start
 Start time (in ticks)
unsigned int count
 Retry count.
void(* expired )(struct retry_timer *timer, int over)
 Timer expired callback.
struct refcntrefcnt
 Reference counter.

Detailed Description

A retry timer.

Definition at line 21 of file retry.h.


Field Documentation

List of active timers.

Definition at line 23 of file retry.h.

Referenced by retry_poll(), start_timer_fixed(), stop_timer(), and timer_expired().

unsigned int retry_timer::running

Timer is currently running.

Definition at line 25 of file retry.h.

Referenced by start_timer_fixed(), stop_timer(), and timer_expired().

unsigned long retry_timer::timeout
unsigned long retry_timer::min

Minimum timeout value (in ticks), or zero to use default.

The timeout will never be reduced below this value.

Definition at line 32 of file retry.h.

Referenced by start_timer().

unsigned long retry_timer::max

Maximum timeout value (in ticks), or zero to use default.

The timeout will be deemed permanent (according to the failure indicator passed to expired()) when it exceeds this value.

Definition at line 39 of file retry.h.

Referenced by timer_expired().

unsigned long retry_timer::start

Start time (in ticks)

Definition at line 41 of file retry.h.

Referenced by retry_poll(), start_timer_fixed(), and stop_timer().

unsigned int retry_timer::count

Retry count.

Definition at line 43 of file retry.h.

Referenced by peerdisc_expired(), stop_timer(), and timer_expired().

void( * retry_timer::expired)(struct retry_timer *timer, int over)

Timer expired callback.

Parameters:
timerRetry timer
failFailure indicator

The timer will already be stopped when this method is called. The failure indicator will be True if the retry timeout has already exceeded max_timeout.

Definition at line 53 of file retry.h.

Referenced by timer_expired().

Reference counter.

If this interface is not part of a reference-counted object, this field may be NULL.

Definition at line 59 of file retry.h.

Referenced by start_timer_fixed(), stop_timer(), and timer_expired().


The documentation for this struct was generated from the following file: