Struct rust_tcp_ipc::TcpIpcConfig

pub struct TcpIpcConfig {
    pub after_connect_wait_time: Option<Duration>,
    pub read_iteration_wait_time: Option<Duration>,
    pub shutdown_wait_time: Option<Duration>,
    pub check_count: u32,
}

This bundles the time-settings for the protocol A ‘None’ value means that there will no time spend waiting.

Example

let config = TcpIpcConfig {
    after_connect_wait_time: Some(std::time::Duration::from_micros(5_000)),
    read_iteration_wait_time: Some(std::time::Duration::from_micros(1)),
    shutdown_wait_time: Some(std::time::Duration::from_micros(5_000_000)),
    check_count: 1,
};

Fields

after_connect_wait_time: Option<Duration>

This is the time the program waits for the server after it accepted the initial TCP connection. For example, this can be used to wait for the server doing some initialization. Moreover, the message read queue thread needs some time to start.

read_iteration_wait_time: Option<Duration>

This is the time the client sleeps between checking for new messages from the server. Very small values can yield high CPU-usage.

shutdown_wait_time: Option<Duration>

This is the time the client waits for the server to accept a shutdown request.

check_count: u32

This is the number of iterations inside the read thread after which the busy_update_state will be checked A good default value is 1 (check after each iteration)

Trait Implementations

impl Clone for TcpIpcConfig

fn clone(&self) -> TcpIpcConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TcpIpcConfig

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

Formats the value using the given formatter.

impl PartialEq<TcpIpcConfig> for TcpIpcConfig

fn eq(&self, other: &TcpIpcConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for TcpIpcConfig

impl StructuralPartialEq for TcpIpcConfig