mio 1.2.0

Lightweight non-blocking I/O.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

use std::io;
use std::os::fd::RawFd;
use std::sync::atomic::{AtomicBool, Ordering::Relaxed};

/// Waker backed by a boolean value.
///
/// This implementation is meant for systems with only a single thread of
/// control, in which case it is not possible to wake a thread which is already
/// blocked on a select call. Thus, this may only be used to ensure the next
/// select call by the current thread polls without blocking.
///
/// Note that this is currently meant only for use with the `poll(2)`
/// implementation, which has special support for using a zero timeout when
/// `Waker::woken` returns `true`.
#[derive(Debug)]
pub(crate) struct Waker {
    woken: AtomicBool,
}

impl Waker {
    pub(crate) fn new_unregistered() -> io::Result<Waker> {
        Ok(Waker {
            woken: AtomicBool::new(false),
        })
    }

    pub(crate) fn wake(&self) -> io::Result<()> {
        self.woken.store(true, Relaxed);
        Ok(())
    }

    /// Only non-`None` for the `pipe(2)`- and `eventfd(2)`-based `Waker`s:
    pub(crate) fn fd(&self) -> Option<RawFd> {
        None
    }

    pub(crate) fn woken(&self) -> bool {
        self.woken.load(Relaxed)
    }

    pub(crate) fn ack_and_reset(&self) {
        self.woken.store(false, Relaxed);
    }
}