Struct calloop::timer::Timer

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

A Timer event source

It generates events of type (T, TimerHandle<T>), providing you an handle inside the event callback, allowing you to set new timeouts as a response to a timeout being reached (for reccuring ticks for example).

Implementations

impl<T> Timer<T>

pub fn new() -> Result<Timer<T>>

Create a new timer with default parameters

Default time resolution is 100ms

pub fn handle(&self) -> TimerHandle<T>

Get an handle for this timer

Trait Implementations

impl<T: 'static> EventSource for Timer<T>

type Event = T

The type of events generated by your source.

type Metadata = TimerHandle<T>

Some metadata of your event source

type Ret = ()

The return type of the user callback

fn process_events<C>(
    &mut self,
    readiness: Readiness,
    token: Token,
    callback: C
) -> Result<()> where
    C: FnMut(Self::Event, &mut Self::Metadata) -> Self::Ret, 

Process any relevant events

fn register(&mut self, poll: &mut Poll, token: Token) -> Result<()>

Register yourself to this poll instance

fn reregister(&mut self, poll: &mut Poll, token: Token) -> Result<()>

Re-register your file descriptors

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

Unregister your file descriptors