TsgcWebSocketClient › Properties › Options
Customizes handshake headers and fine-tunes client behaviour such as fragmentation and UTF-8 validation.
property Options: TsgcWSOptionsClient read FOptions write SetOptions;FragmentedMessages=frgOnlyBuffer, RaiseDisconnectExceptions=True, ValidateUTF8=False, CleanDisconnect=False, WaitForConnect=False
Exposes handshake and runtime settings: Parameters (extra GET parameters), Origin (custom Origin header) and FragmentedMessages which selects whether fragments are buffered (frgOnlyBuffer), reported individually (frgOnlyFragmented) or both (frgAll). RaiseDisconnectExceptions raises an exception on protocol-error disconnects, ValidateUTF8 verifies UTF-8 compliance of text frames and CleanDisconnect sends a close frame before dropping the TCP session.
WaitForConnect controls when the synchronous Connect call returns. By default (False) Connect returns as soon as the WebSocket transport is connected, which can be before the OnConnect event has fired. When set to True, Connect returns only after the OnConnect event has run, so for a sub-protocol that establishes a session on connect (for example the sgc protocol, which assigns a session in its OnConnect) the connection is fully ready as soon as Connect returns. This avoids a connect-readiness race on fast reconnects, where code that inspects the connection immediately after Connect could run before the sub-protocol OnConnect had fired. It applies when NotifyEvents is neNoSync, where events run inline on the read thread. With neAsynchronous the OnConnect event is queued to the main thread and cannot be awaited inside Connect, so use the OnConnect event to detect readiness in that case.
oClient := TsgcWebSocketClient.Create(nil);
oClient.URL := 'wss://www.esegece.com:2053';
oClient.Options.Parameters := '/ws/';
oClient.Options.ValidateUTF8 := true;
oClient.Options.CleanDisconnect := true;
oClient.Options.WaitForConnect := true;
oClient.Active := true;