libevent 0.2.0

Rust bindings to the libevent async I/O framework
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
45
46
47
48
49
50
51
52
53
54

//! Rust bindings to the [libevent] async I/O framework.
//!
//! [libevent]: https://libevent.org/

use std::time::Duration;

mod event;
pub use event::{Event, Fd, Interval, Oneshot};

mod base;
pub use base::{
    Base, EventCallbackCtx, EventCallbackFlags, EventFlags, EvutilSocket, ExitReason, LoopFlags,
};

/// The context passed into `handle_wrapped_callback`, which handles event-type
/// specific metadata for trampolining into the user-supplied closure.
pub(crate) struct EventCallbackWrapper<S, T, F> {
    inner: F,
    event: Option<Event<S>>,
    _phantom: std::marker::PhantomData<T>,
}

impl Base {
    /// Turns the libevent base once.
    // TODO: any way to show if work was done?
    pub fn turn(&self) -> ExitReason {
        self.loop_(LoopFlags::NONBLOCK)
    }

    /// Turns the libevent base until exit or timeout duration reached.
    pub fn run_timeout(&self, timeout: Duration) -> ExitReason {
        if self.loopexit(timeout) != 0 {
            // TODO: This conflates errors, is it ok?
            return ExitReason::Error;
        };
        self.loop_(LoopFlags::empty())
    }

    /// Turns the libevent base until next active event.
    pub fn run_until_event(&self, timeout: Option<Duration>) -> ExitReason {
        if let Some(timeout) = timeout {
            if self.loopexit(timeout) != 0 {
                // TODO: This conflates errors, is it ok?
                return ExitReason::Error;
            }
        }
        self.loop_(LoopFlags::ONCE)
    }

    /// Turns the libevent base until exit.
    pub fn run(&self) -> ExitReason {
        self.loop_(LoopFlags::empty())
    }
}