A class representing a specific WebSocket connection.
    public class WebSocketPeer : PacketPeer

This class represent a specific WebSocket connection, you can do lower level operations with it.

You can choose to write to the socket in binary or text mode, and you can recognize the mode used for writing by the other peer.

Inheritance Chain


    public WebSocketPeer()


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

Closes this WebSocket connection. code is the status code for the closure (see RFC 6455 section 7.4 for a list of valid status codes). reason is the human readable reason for closing the connection (can be any UTF-8 string that’s smaller than 123 bytes).

Note: To achieve a clean close, you will need to keep polling until either connection_closed or client_disconnected is received.

Note: The HTML5 export might not support all status codes. Please refer to browser-specific documentation for more details.

    public string GetConnectedHost()

Returns the IP address of the connected peer.

Note: Not available in the HTML5 export.

    public ushort GetConnectedPort()

    public WriteMode GetWriteMode()

Gets the current selected write mode. See WriteMode.

    public bool IsConnectedToHost()

Returns true if this peer is currently connected.

    public void SetWriteMode(WriteMode mode)

Sets the socket to use the given WriteMode.

    public bool WasStringPacket()

Returns true if the last received packet was sent as a text payload. See WriteMode

Inner Types


Name Value Description
Text 0 Specifies that WebSockets messages should be transferred as text payload (only valid UTF-8 is allowed).
Binary 1 Specifies that WebSockets messages should be transferred as binary payload (any byte combination is allowed).