amy 0.10.0

Polling and Registration abstractions around kqueue and epoll for multithreaded async network programming
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

use std::os::unix::io::{RawFd, AsRawFd};
use std::io::Result;

#[cfg(any(target_os = "linux", target_os = "android"))]
use std::io::Error;

#[cfg(any(target_os = "linux", target_os = "android"))]
use std::mem;
#[cfg(any(target_os = "linux", target_os = "android"))]
use libc;

/// An opaque handle to a user level event.
///
/// On Linux this contains a file descriptor created with
/// [eventfd()](http://man7.org/linux/man-pages/man2/eventfd.2.html)
#[cfg(any(target_os = "linux", target_os = "android"))]
#[derive(Debug)]
pub struct UserEvent {
    #[doc(hidden)]
    pub id: usize,

    #[doc(hidden)]
    pub fd: RawFd
}

#[cfg(any(target_os = "linux", target_os = "android"))]
impl UserEvent {
    pub fn get_id(&self) -> usize {
        self.id
    }

    pub fn clear(&self) -> Result<()> {
        let buf: u64 = 0;
        unsafe {
            let ptr: *mut libc::c_void = mem::transmute(&buf);
            if libc::read(self.fd, ptr, 8) < 0 {
                return Err(Error::last_os_error());
            }
            Ok(())
        }
    }

    pub fn trigger(&self) -> Result<()> {
        let buf: u64 = 1;
        unsafe {
            let ptr: *const libc::c_void = mem::transmute(&buf);
            if libc::write(self.fd, ptr, 8) < 0 {
                return Err(Error::last_os_error());
            }
            Ok(())
        }
    }
}

#[cfg(any(target_os = "linux", target_os = "android"))]
impl Drop for UserEvent {
    fn drop(&mut self) {
        unsafe {
            libc::close(self.fd);
        }
    }
}

#[cfg(any(target_os = "linux", target_os = "android"))]
impl AsRawFd for UserEvent {
    fn as_raw_fd(&self) -> RawFd {
        self.fd
    }
}

/* NON LINUX SYSTEMS */

#[cfg(not(any(target_os = "linux", target_os = "android")))]
pub use kqueue::KernelRegistrar;

/// An opaque handle to a user level event.
///
/// On Kqueue base systems there is no file descriptor
/// The event is clone because of this fact.
#[cfg(not(any(target_os = "linux", target_os = "android")))]
#[derive(Debug, Clone)]
pub struct UserEvent {
    #[doc(hidden)]
    pub id: usize,

    #[doc(hidden)]
    pub registrar: KernelRegistrar
}

#[cfg(not(any(target_os = "linux", target_os = "android")))]
impl UserEvent {
    pub fn get_id(&self) -> usize {
        self.id
    }

    pub fn clear(&self) -> Result<()> {
        self.registrar.clear_user_event(&self)
    }

    pub fn trigger(&self) -> Result<()> {
        self.registrar.trigger_user_event(&self)
    }

    pub fn deregister(&self) -> Result<()> {
        self.registrar.deregister_user_event(self.id)
    }
}

// We don't actually need a RawFd for kqueue and don't want to shrink the id size from usize to i32
#[cfg(not(any(target_os = "linux", target_os = "android")))]
impl AsRawFd for UserEvent {
    fn as_raw_fd(&self) -> RawFd {
        0
    }
}