Struct MemorySocketClient

pub struct MemorySocketClient { /* private fields */ }

Implementation of ClientSocket for clients of an in-memory channel server socket.

In-memory sockets are treated as encrypted and reliable by default for efficiency. Use Self::new_with to use a different policy (this is useful for performane tests).

Implementations

impl MemorySocketClient

pub fn new(client_id: u16, channels: MemorySocketChannels) -> Self

Makes a new in-memory client socket.

pub fn new_with( client_id: u16, channels: MemorySocketChannels, encrypted: bool, reliable: bool, ) -> Self

Makes a new in-memory client socket with a specific encryption and reliability policy.

pub fn id(&self) -> u64

Gets the inner client id that is used to make client addresses.

This may not equal the client_id used in netcode unless you intentionally make them the same.

Trait Implementations

impl ClientSocket for MemorySocketClient

fn is_encrypted(&self) -> bool

Gets the encryption behavior of the socket.

fn is_reliable(&self) -> bool

Gets the reliability of the socket.

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

Gets the data source’s SocketAddr.

fn is_closed(&mut self) -> bool

Checks if the data source is closed.

fn close(&mut self)

Closes the data source.

fn preupdate(&mut self)

Handles data-source-specific logic that must run before receiving packets.

fn try_recv(&mut self, buffer: &mut [u8]) -> Result<(usize, SocketAddr)>

Tries to receive the next packet sent to this data source.

fn postupdate(&mut self)

Handles data-source-specific logic that must run after sending packets.

fn send( &mut self, addr: SocketAddr, packet: &[u8], ) -> Result<(), NetcodeTransportError>

Sends a packet to the designated address.

impl Clone for MemorySocketClient

fn clone(&self) -> MemorySocketClient

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MemorySocketClient

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

Formats the value using the given formatter.