Struct naia_shared::ConnectionConfig

pub struct ConnectionConfig {
    pub disconnection_timeout_duration: Duration,
    pub heartbeat_interval: Duration,
    pub ping_interval: Duration,
    pub ping_sample_size: u16,
}

Contains Config properties which will be used by a Server or Client

Fields

disconnection_timeout_duration: Duration

The duration to wait for communication from a remote host before initiating a disconnect

heartbeat_interval: Duration

The duration to wait before sending a heartbeat message to a remote host, if the host has not already sent another message within that time.

ping_interval: Duration

The duration to wait before sending a ping message to the remote host, in order to estimate RTT time

ping_sample_size: u16

Number of samples to measure Ping & Jitter by. A higher number will smooth out Ping measurements, but at the cost of responsiveness.

Implementations

impl ConnectionConfig

pub fn new(
    disconnection_timeout_duration: Duration,
    heartbeat_interval: Duration,
    ping_interval: Duration,
    rtt_sample_size: u16
) -> Self

Creates a new ConnectionConfig, used to initialize a Connection

Trait Implementations

impl Clone for ConnectionConfig

fn clone(&self) -> ConnectionConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionConfig

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

Formats the value using the given formatter.

impl Default for ConnectionConfig

fn default() -> Self

Returns the “default value” for a type.