Struct mio_extras::timer::Timer
[−]
[src]
pub struct Timer<T> { /* fields omitted */ }
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.
Methods
impl<T> Timer<T>
[src]
pub fn set_timeout(&mut self, delay_from_now: Duration, state: T) -> Timeout
[src]
Set a timeout.
When the timeout occurs, the given state becomes available via poll
.
pub fn cancel_timeout(&mut self, timeout: &Timeout) -> Option<T>
[src]
Cancel a timeout.
If the timeout has not yet occurred, the return value holds the associated state.
pub fn poll(&mut self) -> Option<T>
[src]
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>
[src]
impl<T> Evented for Timer<T>
[src]
fn register(
&self,
poll: &Poll,
token: Token,
interest: Ready,
opts: PollOpt
) -> Result<()>
[src]
&self,
poll: &Poll,
token: Token,
interest: Ready,
opts: PollOpt
) -> Result<()>
Register self
with the given Poll
instance. Read more
fn reregister(
&self,
poll: &Poll,
token: Token,
interest: Ready,
opts: PollOpt
) -> Result<()>
[src]
&self,
poll: &Poll,
token: Token,
interest: Ready,
opts: PollOpt
) -> Result<()>
Re-register self
with the given Poll
instance. Read more
fn deregister(&self, poll: &Poll) -> Result<()>
[src]
Deregister self
from the given Poll
instance Read more