Struct ConnectionConfig

pub struct ConnectionConfig {
    pub available_bytes_per_tick: u64,
    pub server_channels_config: Vec<ChannelConfig>,
    pub client_channels_config: Vec<ChannelConfig>,
}

Configuration for a renet connection and its channels.

Fields

available_bytes_per_tick: u64

The number of bytes that is available per update tick to send messages. Default: 60_000, at 60hz this is becomes 28.8 Mbps

server_channels_config: Vec<ChannelConfig>

The channels that the server sends to the client. The order of the channels in this Vec determines which channel has priority when generating packets. Each tick, the first channel can consume up to available_bytes_per_tick, used bytes are removed from it and passed to the next channel

client_channels_config: Vec<ChannelConfig>

The channels that the client sends to the server. The order of the channels in this Vec determines which channel has priority when generating packets. Each tick, the first channel can consume up to available_bytes_per_tick, used bytes are removed from it and passed to the next channel

Implementations

impl ConnectionConfig

pub fn from_channels( server: Vec<ChannelConfig>, client: Vec<ChannelConfig>, ) -> Self

Makes a new config with default available_bytes_per_tick.

pub fn from_shared_channels(channels: Vec<ChannelConfig>) -> Self

Makes a new config with default available_bytes_per_tick and the same server and client channels.

pub fn test() -> Self

Makes a new config for testing purposes.

pub fn downgrade_to_unreliable(&mut self)

Downgrades all channels to SendType::Unreliable.

Used when setting up a client that has a socket with built-in reliability (such as WebSockets).

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.