Struct Timer

pub struct Timer<T> { /* private fields */ }

A timer.

Typical usage goes like this:

• register the timer with a mio::Poll.
• set a timeout, by calling Timer::set_timeout. Here you provide some state to be associated with this timeout.
• poll the Poll, to learn when a timeout has occurred.
• retrieve state associated with the timeout by calling Timer::poll.

You can omit use of the Poll altogether, if you like, and just poll the Timer directly.

Implementations

impl<T> Timer<T>

pub fn set_timeout(&mut self, delay_from_now: Duration, state: T) -> Timeout

Set a timeout.

When the timeout occurs, the given state becomes available via poll.

pub fn cancel_timeout(&mut self, timeout: &Timeout) -> Option<T>

Cancel a timeout.

If the timeout has not yet occurred, the return value holds the associated state.

pub fn poll(&mut self) -> Option<T>

Poll for an expired timer.

The return value holds the state associated with the first expired timer, if any.

Trait Implementations

impl<T> Default for Timer<T>

fn default() -> Timer<T>

Returns the “default value” for a type.

impl<T> Evented for Timer<T>

fn register( &self, poll: &Poll, token: Token, interest: Ready, opts: PollOpt, ) -> Result<()>

Register self with the given Poll instance.

fn reregister( &self, poll: &Poll, token: Token, interest: Ready, opts: PollOpt, ) -> Result<()>

Re-register self with the given Poll instance.

fn deregister(&self, poll: &Poll) -> Result<()>

Deregister self from the given Poll instance