Struct RenetClient

pub struct RenetClient { /* private fields */ }

Implementations

impl RenetClient

pub fn new(config: ConnectionConfig, has_reliable_socket: bool) -> Self

The has_reliable_socket argument must match with the underlying socket.

It will be false for sockets like UDP or WebTransport, and true for in-memory sockets and WebSockets.

See ClientSocket::is_reliable in renet2_netcode.

pub fn has_reliable_socket(&self) -> bool

Returns whether this client uses a reliable underlying socket.

pub fn rtt(&self) -> f64

Returns the round-time trip for the connection.

pub fn packet_loss(&self) -> f64

Returns the packet loss for the connection.

pub fn bytes_sent_per_sec(&self) -> f64

Returns the bytes sent per second in the connection.

pub fn bytes_received_per_sec(&self) -> f64

Returns the bytes received per second in the connection.

pub fn network_info(&self) -> NetworkInfo

Returns all network informations for the connection.

pub fn is_connected(&self) -> bool

Returns whether the client is connected.

pub fn is_connecting(&self) -> bool

Returns whether the client is connecting.

pub fn is_disconnected(&self) -> bool

Returns whether the client is disconnected.

pub fn disconnect_reason(&self) -> Option<DisconnectReason>

Returns the disconnect reason if the client is disconnected.

pub fn set_connected(&mut self)

Set the client connection status to connected.

Does nothing if the client is disconnected. A disconnected client must be reconstructed.

Note: This should only be called by the transport layer.

pub fn set_connecting(&mut self)

Set the client connection status to connecting.

Does nothing if the client is disconnected. A disconnected client must be reconstructed.

Note: This should only be called by the transport layer.

pub fn disconnect(&mut self)

Disconnect the client.

If the client is already disconnected, it does nothing.

pub fn disconnect_due_to_transport(&mut self)

Disconnect the client because an error occurred in the transport layer.

If the client is already disconnected, it does nothing.

Note: This should only be called by the transport layer.

pub fn channel_available_memory<I: Into<u8>>(&self, channel_id: I) -> usize

Returns the available memory in bytes for the given channel.

pub fn can_send_message<I: Into<u8>>( &self, channel_id: I, size_bytes: usize, ) -> bool

Checks if the channel can send a message with the given size in bytes.

pub fn send_message<I: Into<u8>, B: Into<Bytes>>( &mut self, channel_id: I, message: B, )

Send a message to the server over a channel.

pub fn receive_message<I: Into<u8>>(&mut self, channel_id: I) -> Option<Bytes>

Receive a message from the server over a channel.

pub fn update(&mut self, duration: Duration)

Advances the client by the duration. Should be called every tick

pub fn process_packet(&mut self, packet: &[u8])

Process a packet received from the server.

Note: This should only be called by the transport layer.

pub fn get_packets_to_send(&mut self) -> Vec<Payload>

Returns a list of packets to be sent to the server.

Note: This should only be called by the transport layer.

Trait Implementations

impl Debug for RenetClient

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

Formats the value using the given formatter.

impl Resource for RenetClient

where Self: Send + Sync + 'static,