Struct MemorySocketServer

pub struct MemorySocketServer { /* private fields */ }

Implementation of ServerSocket for a server socket using in-memory channels.

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 performance tests).

Implementations

impl MemorySocketServer

pub fn new(clients: Vec<(u16, MemorySocketChannels)>) -> Self

Makes a new in-memory socket for a server.

Takes a vector of (client id, socket channels).

pub fn new_with( clients: Vec<(u16, MemorySocketChannels)>, encrypted: bool, reliable: bool, ) -> Self

Makes a new in-memory socket for a server with a specific encryption policy.

Takes a vector of (client id, socket channels).

If encrypted is set to true then the memory transport will be treated as if it were encrypted. If you want renet2 to encrypt the channel, set it to false.

If reliable is set to true then the memory transport will downgrade all channels to unreliable. If you don’t want to downgrade channels (e.g. for performance testing), set it to false.

Trait Implementations

impl Debug for MemorySocketServer

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

Formats the value using the given formatter.

impl ServerSocket for MemorySocketServer

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 connection_denied(&mut self, _: SocketAddr)

Notifies the data source that an address’s connection request was denied.

fn connection_accepted(&mut self, _: u64, _: SocketAddr)

Notifies the data source that an address’s connection request was accepted.

fn disconnect(&mut self, _: SocketAddr)

Disconnects a remote connection with the given address.

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.