An implement of interface WebSocket. More...

Inheritance diagram for XmobiTea.ProtonNetCommon.WebSocket:

Public Member Functions
	WebSocket (IWebSocket originWs)
	Initializes a new instance of the WebSocket class with the specified origin WebSocket.

bool	PerformClientUpgrade (HttpResponse response, string id)
	Performs the WebSocket client upgrade.

bool	PerformServerUpgrade (HttpRequest request, HttpResponse response)
	Performs the WebSocket server upgrade.

void	PrepareSendFrame (byte opcode, bool mask, byte[] buffer, int position, int length, int status=0)
	Prepares the WebSocket frame to be sent.

void	PrepareReceiveFrame (byte[] buffer, int position, int length)
	Prepares the WebSocket frame received for processing.

void	ClearWsBuffers ()
	Clears the WebSocket buffers.

void	InitWsNonce ()
	Initializes the WebSocket nonce with random bytes.

void	OnWsConnecting (HttpRequest request)
	Invoked when a WebSocket connection is being established.

void	OnWsConnected (HttpResponse response)
	Invoked when a WebSocket connection has been successfully established.

bool	OnWsConnecting (HttpRequest request, HttpResponse response)
	Invoked when a WebSocket connection is being established, allowing to modify the response.

void	OnWsConnected (HttpRequest request)
	Invoked when a WebSocket connection has been successfully established.

void	OnWsDisconnecting ()
	Invoked when a WebSocket connection is about to be closed.

void	OnWsDisconnected ()
	Invoked when a WebSocket connection has been closed.

void	OnWsReceived (byte[] buffer, int position, int length)
	Invoked when a WebSocket message has been received.

void	OnWsClose (byte[] buffer, int position, int length, int status=1000)
	Invoked when a WebSocket close frame has been received.

void	OnWsPing (byte[] buffer, int position, int length)
	Invoked when a WebSocket ping frame has been received.

void	OnWsPong (byte[] buffer, int position, int length)
	Invoked when a WebSocket pong frame has been received.

void	OnWsError (string error)
	Invoked when a WebSocket error occurs, providing an error message.

void	OnWsError (SocketError error)
	Invoked when a WebSocket error occurs, providing a SocketError.

void	SendUpgrade (HttpResponse response)
	Sends an HTTP response to complete the WebSocket upgrade process.

Public Member Functions inherited from XmobiTea.ProtonNetCommon.IWebSocket

Properties
bool	handshaked `[get, set]`
	Indicates whether the WebSocket handshake has been completed.

object	sendLock `[get]`
	The lock object used to synchronize access to the send buffer.

IMemoryBuffer	sendBuffer `[get]`
	The buffer used to store the WebSocket frame to be sent.

byte[]	nonce `[get]`
	The nonce used during the WebSocket handshake.

Detailed Description

An implement of interface WebSocket.

Constructor & Destructor Documentation

◆ WebSocket()

XmobiTea.ProtonNetCommon.WebSocket.WebSocket ( IWebSocket originWs )

Initializes a new instance of the WebSocket class with the specified origin WebSocket.

Parameters

originWs The origin WebSocket instance.

Member Function Documentation

◆ OnWsClose()

void XmobiTea.ProtonNetCommon.WebSocket.OnWsClose	(	byte[]	buffer,
		int	position,
		int	length,
		int	status = 1000 )

Invoked when a WebSocket close frame has been received.

Parameters

buffer	The buffer containing the close frame data.
position	The position in the buffer where the data starts.
length	The length of the close frame data.
status	The close status code.

Implements XmobiTea.ProtonNetCommon.IWebSocket.

◆ OnWsConnected() [1/2]

void XmobiTea.ProtonNetCommon.WebSocket.OnWsConnected ( HttpRequest request )

Invoked when a WebSocket connection has been successfully established.

Parameters

request The HTTP request initiating the connection.

Implements XmobiTea.ProtonNetCommon.IWebSocket.

◆ OnWsConnected() [2/2]

void XmobiTea.ProtonNetCommon.WebSocket.OnWsConnected ( HttpResponse response )

Invoked when a WebSocket connection has been successfully established.

Parameters

response The HTTP response confirming the connection.

Implements XmobiTea.ProtonNetCommon.IWebSocket.

◆ OnWsConnecting() [1/2]

void XmobiTea.ProtonNetCommon.WebSocket.OnWsConnecting ( HttpRequest request )

Invoked when a WebSocket connection is being established.

Parameters

request The HTTP request initiating the connection.

Implements XmobiTea.ProtonNetCommon.IWebSocket.

◆ OnWsConnecting() [2/2]

bool XmobiTea.ProtonNetCommon.WebSocket.OnWsConnecting	(	HttpRequest	request,
		HttpResponse	response )

Invoked when a WebSocket connection is being established, allowing to modify the response.

Parameters

request	The HTTP request initiating the connection.
response	The HTTP response confirming the connection.

Returns: True if the connection should be accepted; otherwise, false.

Implements XmobiTea.ProtonNetCommon.IWebSocket.

◆ OnWsDisconnected()

void XmobiTea.ProtonNetCommon.WebSocket.OnWsDisconnected ( )

Invoked when a WebSocket connection has been closed.

Implements XmobiTea.ProtonNetCommon.IWebSocket.

◆ OnWsDisconnecting()

void XmobiTea.ProtonNetCommon.WebSocket.OnWsDisconnecting ( )

Invoked when a WebSocket connection is about to be closed.

Implements XmobiTea.ProtonNetCommon.IWebSocket.

◆ OnWsError() [1/2]

void XmobiTea.ProtonNetCommon.WebSocket.OnWsError ( SocketError error )

Invoked when a WebSocket error occurs, providing a SocketError.

Parameters

error The SocketError that occurred.

Implements XmobiTea.ProtonNetCommon.IWebSocket.

◆ OnWsError() [2/2]

void XmobiTea.ProtonNetCommon.WebSocket.OnWsError ( string error )

Invoked when a WebSocket error occurs, providing an error message.

Parameters

error The error message.

Implements XmobiTea.ProtonNetCommon.IWebSocket.

◆ OnWsPing()

void XmobiTea.ProtonNetCommon.WebSocket.OnWsPing	(	byte[]	buffer,
		int	position,
		int	length )

Invoked when a WebSocket ping frame has been received.

Parameters

buffer	The buffer containing the ping frame data.
position	The position in the buffer where the data starts.
length	The length of the ping frame data.

Implements XmobiTea.ProtonNetCommon.IWebSocket.

◆ OnWsPong()

void XmobiTea.ProtonNetCommon.WebSocket.OnWsPong	(	byte[]	buffer,
		int	position,
		int	length )

Invoked when a WebSocket pong frame has been received.

Parameters

buffer	The buffer containing the pong frame data.
position	The position in the buffer where the data starts.
length	The length of the pong frame data.

Implements XmobiTea.ProtonNetCommon.IWebSocket.

◆ OnWsReceived()

void XmobiTea.ProtonNetCommon.WebSocket.OnWsReceived	(	byte[]	buffer,
		int	position,
		int	length )

Invoked when a WebSocket message has been received.

Parameters

buffer	The buffer containing the received data.
position	The position in the buffer where the data starts.
length	The length of the received data.

Implements XmobiTea.ProtonNetCommon.IWebSocket.

◆ PerformClientUpgrade()

bool XmobiTea.ProtonNetCommon.WebSocket.PerformClientUpgrade	(	HttpResponse	response,
		string	id )

Performs the WebSocket client upgrade.

Parameters

response	The HTTP response for the upgrade.
id	The WebSocket ID.

Returns: True if the upgrade was successful, otherwise false.

◆ PerformServerUpgrade()

bool XmobiTea.ProtonNetCommon.WebSocket.PerformServerUpgrade	(	HttpRequest	request,
		HttpResponse	response )

Performs the WebSocket server upgrade.

Parameters

request	The HTTP request initiating the upgrade.
response	The HTTP response for the upgrade.

Returns: True if the upgrade was successful, otherwise false.

◆ PrepareReceiveFrame()

void XmobiTea.ProtonNetCommon.WebSocket.PrepareReceiveFrame	(	byte[]	buffer,
		int	position,
		int	length )

Prepares the WebSocket frame received for processing.

Parameters

buffer	The buffer containing the received frame.
position	The position in the buffer where the data starts.
length	The length of the received data.

◆ PrepareSendFrame()

void XmobiTea.ProtonNetCommon.WebSocket.PrepareSendFrame	(	byte	opcode,
		bool	mask,
		byte[]	buffer,
		int	position,
		int	length,
		int	status = 0 )

Prepares the WebSocket frame to be sent.

Parameters

opcode	The operation code of the WebSocket frame.
mask	Indicates whether the frame should be masked.
buffer	The buffer containing the data to be sent.
position	The position in the buffer where the data starts.
length	The length of the data to be sent.
status	The status code for the frame, if applicable.

◆ SendUpgrade()

void XmobiTea.ProtonNetCommon.WebSocket.SendUpgrade ( HttpResponse response )

Sends an HTTP response to complete the WebSocket upgrade process.

Parameters

response The HTTP response to be sent.

Implements XmobiTea.ProtonNetCommon.IWebSocket.

The documentation for this class was generated from the following file:

XmobiTea.ProtonNetCommon/IWebSocket.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ WebSocket()

Member Function Documentation

◆ OnWsClose()

◆ OnWsConnected() [1/2]

◆ OnWsConnected() [2/2]

◆ OnWsConnecting() [1/2]

◆ OnWsConnecting() [2/2]

◆ OnWsDisconnected()

◆ OnWsDisconnecting()

◆ OnWsError() [1/2]

◆ OnWsError() [2/2]

◆ OnWsPing()

◆ OnWsPong()

◆ OnWsReceived()

◆ PerformClientUpgrade()

◆ PerformServerUpgrade()

◆ PrepareReceiveFrame()

◆ PrepareSendFrame()

◆ SendUpgrade()