Struct rust_tcp_ipc::ClientConfig

pub struct ClientConfig {
    pub connect_wait_time_ms: u64,
    pub after_connect_wait_time_ms: u64,
    pub read_iteration_wait_time_ns: u64,
    pub shutdown_wait_time_in_ns: u64,
}

This bundles the time-settings for the protocol

Example

let config = ClientConfig {
    connect_wait_time_ms: 5_000,
    read_iteration_wait_time_ns: 1_000,
    shutdown_wait_time_in_ns: 1_000_000,
};

Fields

connect_wait_time_ms: u64

This is the time the server as to accept a TCP-connection.

after_connect_wait_time_ms: u64

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_ns: u64

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_in_ns: u64

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

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> ClientConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfig

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

Formats the value using the given formatter.

impl PartialEq<ClientConfig> for ClientConfig

fn eq(&self, other: &ClientConfig) -> 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 ClientConfig

impl StructuralPartialEq for ClientConfig