Go to file
Taiki Endo f0afd7788e
Release 2.5.2 (#58)
2022-12-13 12:26:59 +09:00
.github/workflows Test x86_64-pc-windows-gnu with Wine on CI (#53) 2022-11-30 23:21:01 +09:00
examples Small cleanup 2020-10-02 17:34:53 +02:00
src Future-proof the kevent API (#56) 2022-12-13 12:16:19 +09:00
tests Clean up CI config 2022-01-09 01:50:42 +09:00
.gitignore Initial commit 2020-08-06 15:05:24 +02:00
CHANGELOG.md Release 2.5.2 (#58) 2022-12-13 12:26:59 +09:00
Cargo.toml Release 2.5.2 (#58) 2022-12-13 12:26:59 +09:00
LICENSE-APACHE Initial commit 2020-08-06 15:05:24 +02:00
LICENSE-MIT Initial commit 2020-08-06 15:05:24 +02:00
README.md Test x86_64-pc-windows-gnu with Wine on CI (#53) 2022-11-30 23:21:01 +09:00
build.rs Add error message for Wepoll (#54) 2022-11-30 20:26:28 -08:00

README.md

polling

Build License Cargo Documentation

Portable interface to epoll, kqueue, event ports, and wepoll.

Supported platforms:

  • epoll: Linux, Android
  • kqueue: macOS, iOS, FreeBSD, NetBSD, OpenBSD, DragonFly BSD
  • event ports: illumos, Solaris
  • poll: VxWorks, Fuchsia, other Unix systems
  • wepoll: Windows, Wine (version 7.13+)

Polling is done in oneshot mode, which means interest in I/O events needs to be reset after an event is delivered if we're interested in the next event of the same kind.

Only one thread can be waiting for I/O events at a time.

Examples

use polling::{Event, Poller};
use std::net::TcpListener;

// Create a TCP listener.
let socket = TcpListener::bind("127.0.0.1:8000")?;
socket.set_nonblocking(true)?;
let key = 7; // Arbitrary key identifying the socket.

// Create a poller and register interest in readability on the socket.
let poller = Poller::new()?;
poller.add(&socket, Event::readable(key))?;

// The event loop.
let mut events = Vec::new();
loop {
    // Wait for at least one I/O event.
    events.clear();
    poller.wait(&mut events, None)?;

    for ev in &events {
        if ev.key == key {
            // Perform a non-blocking accept operation.
            socket.accept()?;
            // Set interest in the next readability event.
            poller.modify(&socket, Event::readable(key))?;
        }
    }
}

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.