Struct lightyear::connection::netcode::ServerConfig

pub struct ServerConfig<Ctx> { /* private fields */ }

Configuration for a server.

• num_disconnect_packets - The number of redundant disconnect packets that will be sent to a client when the server is disconnecting it.
• keep_alive_send_rate - The rate at which keep-alive packets will be sent to clients.
• on_connect - A callback that will be called when a client is connected to the server.
• on_disconnect - A callback that will be called when a client is disconnected from the server.

Example

use std::sync::{Arc, Mutex};
use crate::lightyear::connection::netcode::{NetcodeServer, ServerConfig};

let thread_safe_counter = Arc::new(Mutex::new(0));
let cfg = ServerConfig::with_context(thread_safe_counter).on_connect(|idx, _, ctx| {
    let mut counter = ctx.lock().unwrap();
    *counter += 1;
    println!("client {} connected, counter: {idx}", counter);
});
let server = NetcodeServer::with_config(protocol_id, private_key, cfg).unwrap();

Implementations

impl<Ctx> ServerConfig<Ctx>

pub fn new() -> ServerConfig<()>

Create a new, default server configuration with no context.

pub fn with_context(ctx: Ctx) -> Self

Create a new server configuration with context that will be passed to the callbacks.

pub fn num_disconnect_packets(self, num: usize) -> Self

Set the number of redundant disconnect packets that will be sent to a client when the server is disconnecting it.
The default is 10 packets.

pub fn keep_alive_send_rate(self, rate_seconds: f64) -> Self

Set the rate (in seconds) at which keep-alive packets will be sent to clients.
The default is 10 packets per second. (0.1 seconds)

pub fn client_timeout_secs(self, client_timeout_secs: i32) -> Self

Set the duration (in seconds) after which the server disconnects a client if they don’t hear from them. The default is 10 seconds.

pub fn token_expire_secs(self, expire_secs: i32) -> Self

Set the duration (in seconds) after which ConnectTokens generated by the server will expire The default is 30 seconds.

pub fn server_addr(self, server_addr: SocketAddr) -> Self

Set the socket address of the server.

pub fn on_connect<F>(self, cb: F) -> Self

where F: FnMut(ClientId, SocketAddr, &mut Ctx) + Send + Sync + 'static,

Provide a callback that will be called when a client is connected to the server.
The callback will be called with the client index and the context that was provided (provide a None context if you don’t need one).

See ServerConfig for an example.

pub fn on_disconnect<F>(self, cb: F) -> Self

where F: FnMut(ClientId, SocketAddr, &mut Ctx) + Send + Sync + 'static,

Provide a callback that will be called when a client is disconnected from the server.
The callback will be called with the client index and the context that was provided (provide a None context if you don’t need one).

See ServerConfig for an example.

Trait Implementations

impl Default for ServerConfig<()>

fn default() -> Self

Returns the “default value” for a type.