Struct NetcodeServerTransport 

pub struct NetcodeServerTransport { /* private fields */ }

Available on crate feature netcode only.

Implementations

impl NetcodeServerTransport

pub fn new( server_config: ServerSetupConfig, socket: impl ServerSocket, ) -> Result<NetcodeServerTransport, Error>

Makes a new server transport that uses netcode for managing connections and data flow.

pub fn new_with_sockets( server_config: ServerSetupConfig, boxed: Vec<BoxedSocket>, ) -> Result<NetcodeServerTransport, Error>

Makes a new server transport that uses netcode for managing connections and data flow.

Multiple ServerSockets may be inserted. Each socket must line up 1:1 with socket entries in ServerSetupConfig::socket_addresses.

pub fn addresses(&self) -> Vec<SocketAddr>

Returns the server’s public addresses for the first transport socket.

pub fn get_addresses(&self, socket_id: usize) -> Option<Vec<SocketAddr>>

Returns the server’s public addresses for a given socket_id.

pub fn max_clients(&self) -> usize

Returns the maximum number of clients that can be connected.

pub fn set_max_clients(&mut self, max_clients: usize)

Update the maximum numbers of clients that can be connected.

Changing the max_clients to a lower value than the current number of connect clients does not disconnect clients. So NetcodeServerTransport::connected_clients() can return a higher value than NetcodeServerTransport::max_clients().

pub fn connected_clients(&self) -> usize

Returns current number of clients connected.

pub fn user_data(&self, client_id: u64) -> Option<[u8; 256]>

Returns the user data for client if connected.

pub fn client_addr(&self, client_id: u64) -> Option<(usize, SocketAddr)>

Returns the client socket id and address if connected.

pub fn disconnect_all(&mut self, server: &mut RenetServer)

Disconnects all connected clients.

This sends the disconnect packet instantly, use this when closing/exiting games, should use RenetServer::disconnect_all otherwise.

pub fn time_since_last_received_packet( &self, client_id: u64, ) -> Option<Duration>

Returns the duration since the connected client last received a packet.

Useful to detect users that are timing out.

pub fn update( &mut self, duration: Duration, server: &mut RenetServer, ) -> Result<(), Vec<NetcodeTransportError>>

Advances the transport by the duration, and receive packets from the network.

pub fn send_packets(&mut self, server: &mut RenetServer)

Sends packets to connected clients.

Trait Implementations

impl Debug for NetcodeServerTransport

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

Formats the value using the given formatter.

impl Resource for NetcodeServerTransport

where NetcodeServerTransport: Send + Sync + 'static,