Struct hinix::eventfd::EventFd

pub struct EventFd { /* fields omitted */ }

An event object that can be used as a wait/notify mechanism between user-space applications, threads in an app, or between the kernel and user-space.

This is a simpler, more efficient signaling mechanism than a pipe, if event notification is all that is required by the application.

The event is seen as a normal file handle, and thus can be used in combination with other handles such as from sockets, pipes, etc, in a poll/epoll/select call to provide additional signaling capabilities.

Implementations

impl EventFd

pub fn new(initval: u64) -> Result<EventFd>

Create a new event object.

This is the default configuration of the event object with no flags. When read, the value is returned and the count is reset to zero.

Parameters

initval The initial value held by the object

pub fn new_semaphore(initval: u64) -> Result<EventFd>

Create a new event object with the semaphore option.

This is applies the EDF_SEMAPHORE flag. When read, the value returned is 1, and the value is decremented by 1.

Parameters

initval The initial value held by the object

pub fn with_flags(initval: u64, flags: EfdFlags) -> Result<EventFd>

Create a new event object with the specified flags.

Parameters

initval The initial value held by the object flags The flags used to create the object

http://man7.org/linux/man-pages/man2/eventfd.2.html

pub fn try_clone(&self) -> Result<Self>

Try to clone the event object by making a dup() of the OS file handle.

pub fn read(&self) -> Result<u64>

Reads the value of the event object.

pub fn write(&self, val: u64) -> Result<()>

Writes a value to the event object.

Parameters

val The value to add to the one held by the object.

Trait Implementations

impl AsRawFd for EventFd

fn as_raw_fd(&self) -> RawFd

Gets the raw file handle for the event object.

impl Debug for EventFd

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

Formats the value using the given formatter.

impl Drop for EventFd

fn drop(&mut self)

Executes the destructor for this type.