TElWebSocketBase.OnCloseConnection method

TElWebSocketBase.OnCloseConnection

Reports a WebSocket session closure.

Declaration

[C#]
event TSBWSCloseConnectionEvent OnCloseConnection;
delegate void TSBWSCloseConnectionEvent(Object Sender, bool Remote, int CloseDescription);

[VB.NET]
Event OnCloseConnection As TSBWSCloseConnectionEvent
Delegate Sub TSBWSCloseConnectionEvent(ByVal Sender As Object, ByVal Remote As Boolean, ByVal CloseDescription As Integer)

[Pascal]
property OnCloseConnection : TSBWSCloseConnectionEvent;
TSBWSCloseConnectionEvent = procedure(Sender : TObject; Remote : boolean; CloseDescription : integer) of object;

[C++]
    void get_OnCloseConnection(TSBWSCloseConnectionEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnCloseConnection(TSBWSCloseConnectionEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBWSCloseConnectionEvent)(void * _ObjectData, TObjectHandle Sender, int8_t Remote, int32_t CloseDescription);

[PHP]
    TSBWSCloseConnectionEvent|callable|NULL get_OnCloseConnection()
    void set_OnCloseConnection(TSBWSCloseConnectionEvent|callable|NULL $Value)
    callable TSBWSCloseConnectionEvent(TObject $Sender, bool $Remote, integer $CloseDescription)

[Java]
    TSBWSCloseConnectionEvent getOnCloseConnection();
    void setOnCloseConnection(TSBWSCloseConnectionEvent Value);
    TSBWSCloseConnectionEvent.Callback OnCloseConnection = new TSBWSCloseConnectionEvent.Callback() {
        public void TSBWSCloseConnectionEventCallback(TObject Sender, boolean Remote, int CloseDescription) {
            //...
        }
    }

Parameters

Remote - specifies whether the closure was requested by the remote endpoint.
CloseDescription - specifies the close reason (WebSocket status code).

WebSocket status codes:

[.NET] [Pascal] [C++]	Value	Description
WS_STATUS_OK	1000 (0x03E8)	Indicates a normal closure.
WS_STATUS_GOING_AWAY	1001 (0x03E9)	Indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.
WS_STATUS_PROTOCOL_ERROR	1002 (0x03EA)	Indicates that an endpoint is terminating the connection due to a protocol error.
WS_STATUS_CANT_ACCEPT_DATA	1003 (0x03EB)	Indicates that an endpoint is terminating the connection because it has received a type of data it cannot accept (e.g., an endpoint that understands only text data may send this if it receives a binary message).
WS_STATUS_RESERVED	1004 (0x03EC)	Reserved.
WS_STATUS_NO_STATUS_CODE	1005 (0x03ED)	1005 is a reserved value and must not be set as a status code in a Close control frame by an endpoint.It is designated for use in applications expecting a status code to indicate that no status code was actually present.
WS_STATUS_CONN_CLOSED_ABNORMALLY	1006 (0x03EE)	1006 is a reserved value and must not be set as a status code in a Close control frame by an endpoint.It is designated for use in applications expecting a status code to indicate that the connection was closed abnormally, e.g., without sending or receiving a Close control frame.
WS_STATUS_NOT_CONSISTENT_DATA	1007 (0x03EF)	Indicates that an endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (e.g., non-UTF-8 data within a text message).
WS_STATUS_POLICY_VIOLATION	1008 (0x03F0)	indicates that an endpoint is terminating the connection because it has received a message that violates its policy.This is a generic status code that can be returned when there is no other more suitable status code (e.g., 1003 or 1009) or if there is a need to hide specific details about the policy.
WS_STATUS_TOO_BIG_MESSAGE	1009 (0x03F1)	Indicates that an endpoint is terminating the connection because it has received a message that is too big for it to process.
WS_STATUS_CLIENT_EXTENSIONS_EXPECTED	1010 (0x03F2)	Indicates that an endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake.The list of extensions that are needed should appear in the /reason/ part of the Close frame. Note that this status code is not used by the server, because it can fail the WebSocket handshake instead.
WS_STATUS_UNEXPECTED	1011 (0x03F3)	Indicates that a server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
WS_STATUS_TLS_HANDSHAKE_FAILURE	1015 (0x03F7)	1015 is a reserved value and must not be set as a status code in a Close control frame by an endpoint.It is designated for use in applications expecting a status code to indicate that the connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can't be verified).

Description

This event is fired before the component closes a WebSocket connection. If Remote parameter is True, the connection is closed in response to a Close (0x8) frame received from the peer.