Struct Client 

pub struct Client { /* private fields */ }

A netcode client.

Drive it by calling update once per frame with the current time. All methods must be called from one thread; the client performs no internal synchronization.

Implementations

impl Client

pub fn new(bind_address: SocketAddr, time: f64) -> Result<Self, Error>

Creates a client with a socket bound to bind_address. Bind to port 0 to let the operating system pick a port.

The client can only reach server addresses in the same address family as the bind address; use new_dual to support connect tokens that mix IPv4 and IPv6 server addresses.

pub fn new_dual( bind_address_ipv4: SocketAddr, bind_address_ipv6: SocketAddr, time: f64, ) -> Result<Self, Error>

Creates a client with one IPv4 socket and one IPv6 socket, so it can connect to server addresses of either family.

pub fn connect(&mut self, connect_token: &[u8; 2048]) -> Result<(), Error>

Starts connecting to the servers listed in the connect token, trying each address in order until one accepts.

Track progress by polling state after each update. On an invalid token this returns an error and the client transitions to ClientState::InvalidConnectToken.

pub fn update(&mut self, time: f64)

Advances the client to the current time: receives and processes packets, sends queued packets and keep-alives, and applies timeouts.

pub fn send_packet(&mut self, payload: &[u8]) -> Result<(), Error>

Sends a payload packet to the server. Does nothing unless the client is connected.

pub fn receive_packet(&mut self) -> Option<(Vec<u8>, u64)>

Pops the next payload packet received from the server, along with its sequence number.

pub fn disconnect(&mut self)

Disconnects from the server, sending redundant disconnect packets so the server finds out quickly.

pub fn state(&self) -> ClientState

The current client state.

pub fn client_index(&self) -> usize

The slot this client occupies on the server, valid while connected.

pub fn max_clients(&self) -> usize

The number of client slots on the server, valid while connected.

pub fn next_packet_sequence(&self) -> u64

The sequence number of the next packet this client will send.

pub fn port(&self) -> u16

The local port the client is bound to.

pub fn server_address(&self) -> Option<SocketAddr>

The server address the client is currently connecting or connected to.

Trait Implementations

impl Drop for Client

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.