Class UART::RxTimer

• Defined in File sim_uart.cpp

Nested Relationships

This class is a nested type of Class UART.

Inheritance Relationships

Base Type

• public CycleTimer (Class CycleTimer)

Class Documentation

class RxTimer : public CycleTimer

Public Functions

inline RxTimer(UART &ctl)

inline virtual cycle_count_t next(cycle_count_t when) override

Callback from the cycle loop.

Note

there’s no guarantee the method will be called exactly on the required ‘when’ cycle. The only guarantee is “called ‘when’ <= ‘current cycle’”, the implementations must account for this.

Note

The next ‘when’ can be in the ‘past’ (i.e. <= ‘current cycle’). In this case, the timer will be called again within the same cycle with the given next ‘when’. The only constraint is that it must be greater than the previous ‘when’. If it’s negative or zero, the timer is removed from the queue.

Parameters:

when – current ‘when’ cycle, at which the timer was scheduled

Returns:

the next ‘when’ the timer requires to be called at.