Struct rsix::io::epoll::Epoll

pub struct Epoll<Context: Context> { /* fields omitted */ }

An “epoll”, an interface to an OS object allowing one to repeatedly wait for events from a set of file descriptors efficiently.

Implementations

impl<Context: Context> Epoll<Context>

pub fn new(flags: CreateFlags, context: Context) -> Result<Self>

epoll_create1(flags)—Creates a new Epoll.

Use the CreateFlags::CLOEXEC flag to prevent the resulting file descriptor from being implicity passed across exec boundaries.

pub fn add(
    &self,
    data: Context::Data,
    event_flags: EventFlags
) -> Result<Ref<'_, Context::Target>>

epoll_ctl(self, EPOLL_CTL_ADD, data, event)—Adds an element to an Epoll.

This registers interest in any of the events set in events occuring on the file descriptor associated with data.

pub fn mod_(
    &self,
    target: Ref<'_, Context::Target>,
    event_flags: EventFlags
) -> Result<()>

epoll_ctl(self, EPOLL_CTL_MOD, target, event)—Modifies an element in this Epoll.

This sets the events of interest with target to events.

pub fn del(&self, target: Ref<'_, Context::Target>) -> Result<Context::Data>

epoll_ctl(self, EPOLL_CTL_DEL, target, NULL)—Removes an element in this Epoll.

This also returns the owning Data.

pub fn wait<'context>(
    &'context self,
    event_list: &mut EventVec<'context, Context>,
    timeout: c_int
) -> Result<()>

epoll_wait(self, events, timeout)—Waits for registered events of interest.

For each event of interest, an element is written to events. On success, this returns the number of written elements.