Struct Server 

pub struct Server<Ctx = ()> { /* private fields */ }

The netcode server.

Responsible for accepting connections from clients and communicating with them using the netcode protocol. The server should be run in a loop to process incoming packets, send updates to clients, and maintain stable connections.

Implementations

impl Server

pub fn new(protocol_id: u64, private_key: Key) -> Result<Self>

Create a new server with a default configuration.

For a custom configuration, use Server::with_config instead.

impl<Ctx> Server<Ctx>

pub fn with_config( protocol_id: u64, private_key: Key, cfg: ServerConfig<Ctx>, ) -> Result<Self>

Create a new server with a custom configuration.
Callbacks with context can be registered with the server to be notified when the server changes states.
See ServerConfig for more details.

Example

let private_key = generate_key();
let protocol_id = 0x123456789ABCDEF0;
let cfg = ServerConfig::with_context(42).on_connect(|idx, _, ctx| {
    assert_eq!(ctx, &42);
});
let server = Server::with_config(protocol_id, private_key, cfg).unwrap();

impl<Ctx> Server<Ctx>

pub fn update_state(&mut self, delta_ms: f64)

Updates the server state without receiving packets.

pub fn receive( &mut self, link: &mut Link, entity_mut: &mut EntityCommands<'_>, ) -> Result<Vec<Error>>

Receive packets from the links, process them. We might buffer some packets to the link as well (for Timeouts or ConnectionRequests, etc.)

pub fn send( &mut self, buf: SendPayload, client_id: u64, sender: &mut LinkSender, ) -> Result<()>

Sends a packet to a client.

The provided buffer must be smaller than MAX_PACKET_SIZE.

pub fn send_all( &mut self, buf: SendPayload, sender: &mut LinkSender, ) -> Result<()>

Sends a packet to all connected clients.

The provided buffer must be smaller than MAX_PACKET_SIZE.

pub fn token( &mut self, client_id: u64, server_addr: SocketAddr, ) -> ConnectTokenBuilder<SocketAddr>

Creates a connect token builder for a given client ID. The builder can be used to configure the token with additional data before generating the final token. The generate method must be called on the builder to generate the final token.

Example

let private_key = generate_key();
let protocol_id = 0x123456789ABCDEF0;
let bind_addr = "0.0.0.0:0";
let mut server = Server::new(protocol_id, private_key).unwrap();

let client_id = 123u64;
let token = server.token(client_id, SocketAddr::from_str(bind_addr).unwrap())
    .expire_seconds(60)  // defaults to 30 seconds, negative for no expiry
    .timeout_seconds(-1) // defaults to 15 seconds, negative for no timeout
    .generate()
    .unwrap();

See ConnectTokenBuilder for more options.

pub fn disconnect( &mut self, client_id: u64, sender: &mut LinkSender, ) -> Result<()>

Disconnects a client.

The server will send a number of redundant disconnect packets to the client, and then remove its connection info.

pub fn disconnect_all(&mut self, sender: &mut LinkSender) -> Result<()>

Disconnects all clients.

pub fn connected_client_ids(&self) -> impl Iterator<Item = u64> + '_

pub fn client_ids(&self) -> impl Iterator<Item = u64> + '_

pub fn num_connected_clients(&self) -> usize

Gets the number of connected clients.

pub fn client_entity(&self, client_id: u64) -> Option<Entity>

Gets the entity of a client.

pub fn local_addr(&self) -> SocketAddr

Gets the address of the server