Struct WebSocketServer

pub struct WebSocketServer { /* private fields */ }

Implementation of ServerSocket for WebSocket servers.

The server handles connections internally with tokio.

If the server is not connected with TLS, then connections will be encrypted using the built-in netcode encryption implemented in renetcode2 that is used for UDP connections. This means TLS is likely not that useful for websocket connections.

Implementations

impl WebSocketServer

pub fn new(config: WebSocketServerConfig, handle: Handle) -> Result<Self, Error>

Makes a new server.

Errors

• Errors if unable to bind to addr, which can happen if your machine is using all ports on a pre-defined IP address.

pub fn url(&self) -> Url

Gets the server URL.

The URL will have the format {ws|wss}://[ip:port]/ws.

pub fn close(&mut self)

Disconnects the server.

Trait Implementations

impl Debug for WebSocketServer

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

Formats the value using the given formatter.

impl Drop for WebSocketServer

fn drop(&mut self)

Executes the destructor for this type.

impl ServerSocket for WebSocketServer

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, addr: SocketAddr)

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

fn connection_accepted(&mut self, client_id: u64, addr: SocketAddr)

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

fn disconnect(&mut self, addr: 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.