Struct ProactorBuilder

pub struct ProactorBuilder { /* private fields */ }

Builder for Proactor.

Implementations

impl ProactorBuilder

pub fn new() -> Self

Create the builder with default config.

pub fn capacity(&mut self, capacity: u32) -> &mut Self

Set the capacity of the inner event queue or submission queue, if exists. The default value is 1024.

pub fn thread_pool_limit(&mut self, value: usize) -> &mut Self

Set the thread number limit of the inner thread pool, if exists. The default value is 256.

It will be ignored if reuse_thread_pool is set.

pub fn thread_pool_recv_timeout(&mut self, timeout: Duration) -> &mut Self

Set the waiting timeout of the inner thread, if exists. The default is 60 seconds.

It will be ignored if reuse_thread_pool is set.

pub fn reuse_thread_pool(&mut self, pool: AsyncifyPool) -> &mut Self

Set to reuse an existing AsyncifyPool in this proactor.

pub fn force_reuse_thread_pool(&mut self) -> &mut Self

Force reuse the thread pool for each proactor created by this builder, even reuse_thread_pool is not set.

pub fn create_or_get_thread_pool(&self) -> AsyncifyPool

Create or reuse the thread pool from the config.

pub fn sqpoll_idle(&mut self, idle: Duration) -> &mut Self

Set io-uring sqpoll idle milliseconds, when sqpoll_idle is set, io-uring sqpoll feature will be enabled

Notes

• Only effective when the io-uring feature is enabled
• idle must >= 1ms, otherwise will set sqpoll idle 0ms
• idle will be rounded down

pub fn coop_taskrun(&mut self, enable: bool) -> &mut Self

coop_taskrun feature has been available since Linux Kernel 5.19. This will optimize performance for most cases, especially compio is a single thread runtime.

However, it can’t run with sqpoll feature.

Notes

• Only effective when the io-uring feature is enabled

pub fn taskrun_flag(&mut self, enable: bool) -> &mut Self

taskrun_flag feature has been available since Linux Kernel 5.19. This allows io-uring driver can know if any cqes are available when try to push sqe to sq. This should be enabled with coop_taskrun

Notes

• Only effective when the io-uring feature is enabled

pub fn register_eventfd(&mut self, fd: RawFd) -> &mut Self

Register an eventfd to io-uring.

Notes

• Only effective when the io-uring feature is enabled

pub fn build(&self) -> Result<Proactor>

Build the Proactor.

Trait Implementations

impl Clone for ProactorBuilder

fn clone(&self) -> ProactorBuilder

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProactorBuilder

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

Formats the value using the given formatter.

impl Default for ProactorBuilder

fn default() -> Self

Returns the “default value” for a type.