Struct NetcodeClientTransport

pub struct NetcodeClientTransport { /* private fields */ }

Implementations

impl NetcodeClientTransport

pub fn new( current_time: Duration, authentication: ClientAuthentication, socket: impl ClientSocket, ) -> Result<Self, NetcodeError>

Makes a new client transport with the given ClientSocket.

pub fn is_reliable(&self) -> bool

Gets the internal socket’s ClientSocket::is_reliable value.

pub fn addr(&self) -> Result<SocketAddr>

Gets the client’s SocketAddr.

Will return an error if the client doesn’t have an address (e.g. a WebTransport client).

pub fn client_id(&self) -> ClientId

Returns the client’s id.

pub fn is_connected(&self) -> bool

Returns true if the netcode client is connected.

pub fn is_connecting(&self) -> bool

Returns true if the netcode client is connecting.

pub fn is_disconnected(&self) -> bool

Returns true if the netcode client is disconnected.

pub fn time_since_last_received_packet(&self) -> Duration

Returns the duration since the client last received a packet.

Useful to detect timeouts.

pub fn disconnect(&mut self)

Disconnects the client from the transport layer.

This sends the disconnect packet instantly, use this when closing/exiting games, should use [RenetClient::disconnect][crate::RenetClient::disconnect] otherwise.

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

If the client is disconnected, returns the reason.

pub fn send_packets( &mut self, connection: &mut RenetClient, ) -> Result<(), NetcodeTransportError>

Sends packets to the server.

Should be called every tick.

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

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

Trait Implementations

impl Debug for NetcodeClientTransport

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

Formats the value using the given formatter.

impl Resource for NetcodeClientTransport

where Self: Send + Sync + 'static,