pub struct ServerConfig<Ctx> { /* private fields */ }
Expand description
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 netcode::{Server, 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 = Server::with_config(addr, protocol_id, private_key, cfg).unwrap();
Implementations§
Source§impl<Ctx> ServerConfig<Ctx>
impl<Ctx> ServerConfig<Ctx>
Sourcepub fn new() -> ServerConfig<()>
pub fn new() -> ServerConfig<()>
Create a new, default server configuration with no context.
Sourcepub fn with_context(ctx: Ctx) -> Self
pub fn with_context(ctx: Ctx) -> Self
Create a new server configuration with context that will be passed to the callbacks.
Sourcepub fn num_disconnect_packets(self, num: usize) -> Self
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.
Sourcepub fn keep_alive_send_rate(self, rate_seconds: f64) -> Self
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)
Sourcepub fn on_connect<F>(self, cb: F) -> Self
pub fn on_connect<F>(self, cb: F) -> Self
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.
Sourcepub fn on_disconnect<F>(self, cb: F) -> Self
pub fn on_disconnect<F>(self, cb: F) -> Self
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.