Struct IoConfig 

pub struct IoConfig { /* private fields */ }

Base io configuration

Implementations

impl IoConfig

pub fn new() -> IoConfig

Create new config object

pub fn tag(&self) -> &str

Get tag

pub fn connect_timeout(&self) -> Millis

Get connect timeout

pub fn keepalive_timeout(&self) -> Seconds

Get keep-alive timeout

pub fn disconnect_timeout(&self) -> Seconds

Get disconnect timeout

pub fn frame_read_rate(&self) -> Option<&FrameReadRate>

Get frame read params

pub fn read_buf(&self) -> &BufConfig

Get read buffer parameters

pub fn write_buf(&self) -> &BufConfig

Get write buffer parameters

pub fn write_page_size(&self) -> BytePageSize

Get write page size

pub fn write_buf_threshold(&self) -> usize

The write buffer threshold that triggers earlier sending.

pub fn set_connect_timeout<T>(self, timeout: T) -> IoConfig

where T: Into<Millis>,

Set connect timeout in seconds.

To disable timeout set value to 0.

By default connect timeout is disabled.

pub fn set_keepalive_timeout<T>(self, timeout: T) -> IoConfig

where T: Into<Seconds>,

Set keep-alive timeout in seconds.

To disable timeout set value to 0.

By default keep-alive timeout is disabled.

pub fn set_disconnect_timeout<T>(self, timeout: T) -> IoConfig

where T: Into<Seconds>,

Set connection disconnect timeout.

Defines a timeout for disconnect connection. If a disconnect procedure does not complete within this time, the connection get dropped.

To disable timeout set value to 0.

By default disconnect timeout is set to 1 seconds.

pub fn set_frame_read_rate( self, timeout: Seconds, max_timeout: Seconds, rate: u32, ) -> IoConfig

Set read rate parameters for single frame.

Set read timeout, max timeout and rate for reading payload. If the client sends rate amount of data within timeout period of time, extend timeout by timeout seconds. But no more than max_timeout timeout.

By default frame read rate is disabled.

pub fn set_read_buf( self, high_watermark: usize, low_watermark: usize, cache_size: usize, ) -> IoConfig

Set read buffer parameters.

By default high watermark is set to 16Kb, low watermark 1kb.

pub fn set_write_page_size(self, size: BytePageSize) -> IoConfig

Set write buffer page size.

By default page size is set to 16kb.

pub fn set_write_buf_threshold(self, size: usize) -> IoConfig

Sets the write buffer threshold.

The app encodes data in response to incoming data, continuing to fill the write buffer until all data has been processed. Only then can the runtime wake the write task to send the buffered data.

By that time, the buffer may have accumulated a large amount of data, causing it to be sent in large bursts, which introduces latency. To prevent this behavior and flatten data delivery to the peer, ntex’s io can initiate out-of-order writes based on a configured threshold.

Set 0 to disable send-buf.

pub fn set_write_buf( self, high_watermark: usize, low_watermark: usize, cache_size: usize, ) -> IoConfig

Set write buffer parameters.

By default high watermark is set to 16Kb, low watermark 1kb.

Trait Implementations

impl Configuration for IoConfig

const NAME: &'static str = "IO Configuration"

fn ctx(&self) -> &CfgContext

fn set_ctx(&mut self, ctx: CfgContext)

impl Debug for IoConfig

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

Formats the value using the given formatter.

impl Default for IoConfig

fn default() -> IoConfig

Returns the “default value” for a type.