TsgcWebSocketHTTPServer › Events › OnError

OnError Event

Fires whenever a WebSocket protocol error occurs, such as a mal-formed handshake.

Syntax

property OnError: TsgcWSErrorEvent;
// TsgcWSErrorEvent = procedure(Connection: TsgcWSConnection; const Error: string) of object

Default Value

—

Remarks

OnError reports protocol-level problems detected by the WebSocket layer on a client connection, such as a mal-formed handshake, an invalid frame, an unsupported opcode, or an invalid UTF-8 payload when Options.ValidateUTF8 is enabled. The Error parameter contains a textual description and the Connection parameter identifies the offending session. Errors raised while dispatching HTTP requests are routed through OnException; OnError is reserved for the WebSocket protocol side of the server.

Example

procedure OnError(Connection: TsgcWSConnection; const Error: string);
begin
  WriteLn('#error on ' + Connection.Guid + ': ' + Error);
end;

Back to Events