Struct ProactorBuilder 

pub struct ProactorBuilder { /* private fields */ }

Builder for Proactor.

Implementations

impl ProactorBuilder

pub fn new() -> ProactorBuilder

Create the builder with default config.

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

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 ProactorBuilder

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.

Warning: some operations don’t work if the limit is set to zero:

• Asyncify needs thread pool.
• Operations except Recv*, Send*, Connect, Accept may need thread pool.

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

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 ProactorBuilder

Set to reuse an existing AsyncifyPool in this proactor.

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

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 ProactorBuilder

Set io-uring sqpoll idle duration,

This will also enable io-uring’s sqpoll feature.

Notes

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

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

Optimize performance for most cases, especially compio is a single thread runtime.

However, it can’t run with sqpoll feature.

Notes

• Available since Linux Kernel 5.19.
• Only effective when the io-uring feature is enabled

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

Allows io-uring driver to know if any cqe’s are available when try to push an sqe to the submission queue.

This should be enabled with coop_taskrun

Notes

• Available since Linux Kernel 5.19.
• Only effective when the io-uring feature is enabled

pub fn register_eventfd(&mut self, fd: i32) -> &mut ProactorBuilder

Register an eventfd to io-uring.

Notes

• Only effective when the io-uring feature is enabled

pub fn detect_opcode_support( &mut self, flags: OpCodeFlag, ) -> &mut ProactorBuilder

Set which io-uring OpCode must be supported by the driver.

Support for io-uring opcodes varies by kernel version. Setting this will force the driver to check for support of the specified opcodes, and when any of them are not supported:

• Fallback to polling driver if fusion driver is enabled,
• Return an Unsupported error when building the proactor otherwise.

Notes

• Only effective when the io-uring feature is enabled
• OpCodeFlag is a bitflag struct, you can combine multiple opcodes with bitwise OR or use OpCodeFlag::all to require all opcodes to be supported.

pub fn driver_type(&mut self, t: DriverType) -> &mut ProactorBuilder

Force a driver type to use.

It is ignored if the fusion driver is disabled.

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

Build the Proactor.

Trait Implementations

impl Clone for ProactorBuilder

fn clone(&self) -> ProactorBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProactorBuilder

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

Formats the value using the given formatter.

impl Default for ProactorBuilder

fn default() -> ProactorBuilder

Returns the “default value” for a type.

impl Send for ProactorBuilder

impl Sync for ProactorBuilder