Struct Proactor

pub struct Proactor { /* private fields */ }

Low-level actions of completion-based IO. It owns the operations to keep the driver safe.

Implementations

impl Proactor

pub fn new() -> Result<Self>

Create Proactor with 1024 entries.

pub fn builder() -> ProactorBuilder

Create ProactorBuilder to config the proactor.

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

Attach an fd to the driver.

Platform specific

• IOCP: it will be attached to the completion port. An fd could only be attached to one driver, and could only be attached once, even if you try_clone it.
• io-uring & polling: it will do nothing but return Ok(()).

pub fn cancel<T: OpCode>(&mut self, op: Key<T>) -> Option<BufResult<usize, T>>

Cancel an operation with the pushed user-defined data.

The cancellation is not reliable. The underlying operation may continue, but just don’t return from Proactor::poll. Therefore, although an operation is cancelled, you should not reuse its user_data.

pub fn push<T: OpCode + 'static>( &mut self, op: T, ) -> PushEntry<Key<T>, BufResult<usize, T>>

Push an operation into the driver, and return the unique key, called user-defined data, associated with it.

pub fn poll( &mut self, timeout: Option<Duration>, entries: &mut impl Extend<usize>, ) -> Result<()>

Poll the driver and get completed entries. You need to call Proactor::pop to get the pushed operations.

pub fn pop<T>( &mut self, op: Key<T>, ) -> PushEntry<Key<T>, (BufResult<usize, T>, u32)>

Get the pushed operations from the completion entries.

Panics

This function will panic if the requested operation has not been completed.

pub fn update_waker<T>(&mut self, op: &mut Key<T>, waker: Waker)

Update the waker of the specified op.

pub fn handle(&self) -> Result<NotifyHandle>

Create a notify handle to interrupt the inner driver.

Trait Implementations

impl AsRawFd for Proactor

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.