Epoll

Struct Epoll 

Source
pub struct Epoll { /* private fields */ }
Expand description

Epoll structure

Implementations§

Source§

impl Epoll

Source

pub fn create() -> Result<Epoll>

Create a new epoll instance

Examples found in repository?
examples/example.rs (line 8)
7fn main() {
8    let mut epoll = Epoll::create().unwrap();
9    let mut listener = UnixListener::bind("test.sock").unwrap();
10    epoll.register(listener.as_raw_fd(), LISTENER, Interest::Both, Mode::Edge).unwrap();
11
12    loop {
13        let mut events = epoll.poll(Some(Duration::from_millis(2000))).unwrap();
14
15        for event in events.iter() {
16            // Handle the event, read from the socket
17            // respond to it etc
18            // Here you could also use the utility functions provided in copoll::event;
19            // example just breaks on first event
20            break;
21        }
22    }
23}
Source

pub fn poll(&mut self, timeout: Option<Duration>) -> Result<Events>

Poll the epoll instance for new events. Call this one on each iteration of your event loop

Examples found in repository?
examples/example.rs (line 13)
7fn main() {
8    let mut epoll = Epoll::create().unwrap();
9    let mut listener = UnixListener::bind("test.sock").unwrap();
10    epoll.register(listener.as_raw_fd(), LISTENER, Interest::Both, Mode::Edge).unwrap();
11
12    loop {
13        let mut events = epoll.poll(Some(Duration::from_millis(2000))).unwrap();
14
15        for event in events.iter() {
16            // Handle the event, read from the socket
17            // respond to it etc
18            // Here you could also use the utility functions provided in copoll::event;
19            // example just breaks on first event
20            break;
21        }
22    }
23}
Source

pub fn register( &mut self, fd: RawFd, token: Token, interest: Interest, mode: Mode, ) -> Result<()>

Register a new file descriptor in the epoll instance

Examples found in repository?
examples/example.rs (line 10)
7fn main() {
8    let mut epoll = Epoll::create().unwrap();
9    let mut listener = UnixListener::bind("test.sock").unwrap();
10    epoll.register(listener.as_raw_fd(), LISTENER, Interest::Both, Mode::Edge).unwrap();
11
12    loop {
13        let mut events = epoll.poll(Some(Duration::from_millis(2000))).unwrap();
14
15        for event in events.iter() {
16            // Handle the event, read from the socket
17            // respond to it etc
18            // Here you could also use the utility functions provided in copoll::event;
19            // example just breaks on first event
20            break;
21        }
22    }
23}
Source

pub fn reregister( &mut self, fd: RawFd, token: Token, interest: Interest, mode: Mode, ) -> Result<()>

Reregister a file descriptor in the epoll instance often used when wanting to change say the mode or interest

Source

pub fn unregister(&mut self, fd: RawFd) -> Result<()>

Stop polling events a file descriptor

Trait Implementations§

Source§

impl AsRawFd for Epoll

Source§

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more
Source§

impl Debug for Epoll

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Drop for Epoll

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl Freeze for Epoll

§

impl RefUnwindSafe for Epoll

§

impl Send for Epoll

§

impl Sync for Epoll

§

impl Unpin for Epoll

§

impl UnwindSafe for Epoll

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.