Struct renetcode::NetcodeClient

pub struct NetcodeClient { /* private fields */ }

A client that can generate encrypted packets that be sent to the connected server, or consume encrypted packets from the server. The client is agnostic from the transport layer, only consuming and generating bytes that can be transported in any way desired.

Implementations

impl NetcodeClient

pub fn new(
    current_time: Duration,
    client_id: u64,
    connect_token: ConnectToken
) -> Self

pub fn connected(&self) -> bool

pub fn client_id(&self) -> u64

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

Returns the reason that the client was disconnected for.

pub fn server_addr(&self) -> SocketAddr

Returns the current server address the client is connected or trying to connect.

pub fn disconnect(&mut self) -> Result<PacketToSend<'_>, NetcodeError>

Disconnect the client from the server. Returns a disconnect packet that should be sent to the server.

pub fn process_packet<'a>(&mut self, buffer: &'a mut [u8]) -> Option<&'a [u8]>

Process any packet received from the server. This function might return a payload sent from the server. If nothing is returned, it was a packet used for the internal protocol or an invalid packet.

pub fn generate_payload_packet(
    &mut self,
    payload: &[u8]
) -> Result<PacketToSend<'_>, NetcodeError>

Returns the server address and an encrypted payload packet that can be sent to the server.

pub fn update(&mut self, duration: Duration) -> Option<(&mut [u8], SocketAddr)>

Update the internal state of the client, receives the duration since last updated. Might return the serve address and a protocol packet to be sent to the server.

Trait Implementations

impl Debug for NetcodeClient

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

Formats the value using the given formatter.