WebSocketPeer

public string[] HandshakeHeaders { get; set; }

The extra HTTP headers to be sent during the WebSocket handshake. Note: Not supported in Web exports due to browser restrictions.

public double HeartbeatInterval { get; set; }

The interval (in seconds) at which the peer will automatically send WebSocket "ping" control frames. When set to 0, no "ping" control frames will be sent. Note: Has no effect in Web exports due to browser restrictions.

public int InboundBufferSize { get; set; }

The size of the input buffer in bytes (roughly the maximum amount of memory that will be allocated for the inbound packets).

public int MaxQueuedPackets { get; set; }

The maximum amount of packets that will be allowed in the queues (both inbound and outbound).

public int OutboundBufferSize { get; set; }

The size of the input buffer in bytes (roughly the maximum amount of memory that will be allocated for the outbound packets).

public string[] SupportedProtocols { get; set; }

Proposed/accepted WebSocket subprotocols. A subprotocol name does not automatically define your game message format.

public Error AcceptStream(StreamPeer stream);

Begins a server WebSocket handshake over a suitable connected stream. Establish TLS first for WSS; ordinary TCP does not add encryption.

public void Close(int code = 1000, string reason = "");

Begins closing with a code/reason. Continue Poll until Closed; owner removal can interrupt the closing handshake.

public Error ConnectToUrl(string url, TlsOptions tlsClientOptions = null);

Begins WS/WSS connection. After Error.Ok continue Poll until Open; use verified TLS options for WSS.

public int GetCloseCode();

Close code when available. Abrupt loss or failed handshake need not have normal code 1000; interpret with state/diagnostics.

public string GetCloseReason();

Returns the received WebSocket close frame status reason string. Only call this method when WebSocketPeer.GetReadyState returns WebSocketPeer.State.Closed.

public string GetConnectedHost();

Returns the IP address of the connected peer. Note: Not available in the Web export.

public ushort GetConnectedPort();

Returns the remote port of the connected peer. Note: Not available in the Web export.

public int GetCurrentOutboundBufferedAmount();

Returns the current amount of data in the outbound websocket buffer. Note: Web exports use WebSocket.bufferedAmount, while other platforms use an internal buffer.

public WebSocketPeer.State GetReadyState();

Returns the ready state of the connection.

public string GetRequestedUrl();

Returns the URL requested by this peer. The URL is derived from the url passed to WebSocketPeer.ConnectToUrl or from the HTTP headers when acting as server (i.e. when using WebSocketPeer.AcceptStream).

public string GetSelectedProtocol();

Returns the selected WebSocket sub-protocol for this connection or an empty string if the sub-protocol has not been selected yet.

public void Poll();

Advances handshake, incoming data and closing. Continue in Closing until Closed or your deadline.

public Error Send(byte[] message, WebSocketPeer.WriteMode writeMode = WebSocketPeer.WriteMode.Binary);

Sends bytes with the selected WriteMode. Binary payload and UTF-8 text are distinct message types; agree the application format separately.

public Error Send(ReadOnlySpan<byte> message, WebSocketPeer.WriteMode writeMode);

Sends bytes with the selected WriteMode. Binary payload and UTF-8 text are distinct message types; agree the application format separately.

public Error SendText(string message);

Sends UTF-8 text on an open connection. Check Error and an application byte limit; successful sending does not establish server-side action completion.

public void SetNoDelay(bool enabled);

Disable Nagle's algorithm on the underlying TCP socket (default). See StreamPeerTcp.SetNoDelay for more information. Note: Not available in the Web export.

public bool WasStringPacket();

Reports the last received packet type. Inspect after GetPacket; it does not describe every future message on the connection.