Struct NetcodeServerTransport

pub struct NetcodeServerTransport { /* private fields */ }

Implementations

impl NetcodeServerTransport

pub fn new( server_config: ServerConfig, socket: UdpSocket, ) -> Result<Self, Error>

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

Returns the server public address

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: ClientId) -> Option<[u8; 256]>

Returns the user data for client if connected.

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

Returns the client 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][crate::RenetServer::disconnect_all] otherwise.

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

Returns the duration since the connected client last received a packet. Usefull to detect users that are timing out.

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

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

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

Send packets to connected clients.

Trait Implementations

impl Debug for NetcodeServerTransport

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

Formats the value using the given formatter.