Struct Workload 

pub struct Workload {
    pub tick_rate: u32,
    pub peak_players: usize,
    pub ops_per_player_per_tick: u32,
    pub stall_tolerance: Duration,
    pub join_burst: usize,
    pub tick_budget: Option<Duration>,
    pub max_payload: usize,
    pub memory_budget: Option<usize>,
    pub priority: Priority,
    pub socket_buffer_bytes: usize,
}

What an application does, in the terms its author already knows.

Fields

tick_rate: u32

How often the server broadcasts, in Hz.

peak_players: usize

Connections held at once.

ops_per_player_per_tick: u32

Op batches one player sends per tick. Zero for a read-only audience.

stall_tolerance: Duration

How long a client may stop reading without losing a frame.

join_burst: usize

Connections that may arrive at once. A server restart reconnects everybody, which is why this defaults to peak_players.

tick_budget: Option<Duration>

What one tick of the application’s own work costs. None reads as the whole tick period, since a tick that costs more than that cannot keep up.

max_payload: usize

Largest frame this build sends, in bytes.

memory_budget: Option<usize>

Bytes this build will spend on outbound queues across every connection. None sizes from stall_tolerance alone.

priority: Priority

Whether a drop or a wait is the worse failure.

socket_buffer_bytes: usize

What the host buffers under the outbound queue. See DEFAULT_SOCKET_BUFFER_BYTES.

Implementations

impl Workload

pub fn action() -> Self

Racing and shooters: fast, small frames, a stale one is worthless.

pub fn horde() -> Self

Many entities in one view: fast, and large enough per frame that memory rather than time is what bounds the queue.

pub fn turn_based() -> Self

Cards, auctions, anything where a lost op is a lost move.

pub fn social_relay() -> Self

Many long-lived connections carrying light traffic, bounded by what the per-connection queues cost multiplied by the connection count.

pub fn spectator() -> Self

An audience that receives and never sends.

pub fn lobby() -> Self

Presence-dominated: connections arrive, wait, and leave for a room.

pub fn local() -> Self

What ships without a workload named at all.

Trait Implementations

impl Clone for Workload

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Workload

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

Formats the value using the given formatter.

impl Default for Workload

fn default() -> Self

Returns the “default value” for a type.