Struct s2n_quic_core::time::timer::Timer

pub struct Timer { /* private fields */ }

A timer that does not trigger an update in a timer list. These are usually owned by individual components and needs to be explicitly polled.

Note: The timer doesn’t implement Copy to ensure it isn’t accidentally moved and have the expiration discarded.

Implementations

impl Timer

pub fn set(&mut self, time: Timestamp)

Sets the timer to expire at the given timestamp

pub fn cancel(&mut self)

Cancels the timer. After cancellation, a timer will no longer report as expired.

pub fn is_expired(&self, current_time: Timestamp) -> bool

Returns true if the timer has expired

pub fn is_armed(&self) -> bool

Returns true if the timer is armed

pub fn poll_expiration(&mut self, current_time: Timestamp) -> Poll<()>

Notifies the timer of the current time. If the timer’s expiration occurs before the current time, it will be cancelled. The method returns whether the timer was expired and had been cancelled.

Trait Implementations

impl Clone for Timer

fn clone(&self) -> Timer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Timer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Timer

fn default() -> Timer

Returns the “default value” for a type.

impl From<Option<Timestamp>> for Timer

fn from(expiration: Option<Timestamp>) -> Self

Converts to this type from the input type.

impl PartialEq for Timer

fn eq(&self, other: &Timer) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Provider for Timer

fn timers<Q: Query>(&self, query: &mut Q) -> Result

Notifies the query of any timers owned by the provider

fn next_expiration(&self) -> Option<Timestamp>

Returns the next Timestamp at which the earliest timer is armed in the provider

fn is_armed(&self) -> bool

Returns true if there are any timers armed

fn armed_timer_count(&self) -> usize

Counts the number of armed timers in the provider

fn for_each_timer<F: FnMut(&Timer) -> Result>(&self, f: F)

Iterates over each timer in the provider and calls the provided function

impl Eq for Timer

impl StructuralPartialEq for Timer