pub struct RenetClient { /* private fields */ }Implementations§
Source§impl RenetClient
impl RenetClient
pub fn new(config: ConnectionConfig) -> Self
Sourcepub fn packet_loss(&self) -> f64
pub fn packet_loss(&self) -> f64
Returns the packet loss for the connection.
Sourcepub fn bytes_sent_per_sec(&self) -> f64
pub fn bytes_sent_per_sec(&self) -> f64
Returns the bytes sent per second in the connection.
Sourcepub fn bytes_received_per_sec(&self) -> f64
pub fn bytes_received_per_sec(&self) -> f64
Returns the bytes received per second in the connection.
Sourcepub fn network_info(&self) -> NetworkInfo
pub fn network_info(&self) -> NetworkInfo
Returns all network informations for the connection.
Sourcepub fn is_connected(&self) -> bool
pub fn is_connected(&self) -> bool
Returns whether the client is connected.
Sourcepub fn is_connecting(&self) -> bool
pub fn is_connecting(&self) -> bool
Returns whether the client is connecting.
Sourcepub fn is_disconnected(&self) -> bool
pub fn is_disconnected(&self) -> bool
Returns whether the client is disconnected.
Sourcepub fn disconnect_reason(&self) -> Option<DisconnectReason>
pub fn disconnect_reason(&self) -> Option<DisconnectReason>
Returns the disconnect reason if the client is disconnected.
Sourcepub fn set_connected(&mut self)
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.
Sourcepub fn set_connecting(&mut self)
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.
Sourcepub fn disconnect(&mut self)
pub fn disconnect(&mut self)
Disconnect the client.
If the client is already disconnected, it does nothing.
Sourcepub fn disconnect_due_to_transport(&mut self)
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.
Sourcepub fn channel_available_memory<I: Into<u8>>(&self, channel_id: I) -> usize
pub fn channel_available_memory<I: Into<u8>>(&self, channel_id: I) -> usize
Returns the available memory in bytes for the given channel.
Sourcepub fn can_send_message<I: Into<u8>>(
&self,
channel_id: I,
size_bytes: usize,
) -> bool
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.
Sourcepub fn send_message<I: Into<u8>, B: Into<Bytes>>(
&mut self,
channel_id: I,
message: B,
)
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.
Sourcepub fn receive_message<I: Into<u8>>(&mut self, channel_id: I) -> Option<Bytes>
pub fn receive_message<I: Into<u8>>(&mut self, channel_id: I) -> Option<Bytes>
Receive a message from the server over a channel.
Sourcepub fn update(&mut self, duration: Duration)
pub fn update(&mut self, duration: Duration)
Advances the client by the duration. Should be called every tick
Sourcepub fn process_packet(&mut self, packet: &[u8])
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.
Sourcepub fn get_packets_to_send(&mut self) -> Vec<Vec<u8>>
pub fn get_packets_to_send(&mut self) -> Vec<Vec<u8>>
Returns a list of packets to be sent to the server.
Note: This should only be called by the transport layer.