TsgcWSPClient_Dataset Events

Events you can handle, grouped by purpose, followed by the full alphabetical list.

Lifecycle

Name	Description
OnConnect	Fires after the WebSocket handshake completes and the Dataset subprotocol is initialized.
OnDisconnect	Fires when the connection is closed, reporting the close code.
OnError	Fires when the server or transport reports an error string.
OnException	Fires when an unhandled exception occurs on the connection.
OnSession	Fires after a successful connection or GetSession request with the assigned session Guid.

Messaging

Name	Description
OnMessage	Fires when a plain text message arrives on the sgc channel.
OnBinary	Fires when a binary frame arrives; payload is delivered as a TMemoryStream.
OnFragmented	Fires for fragmented WebSocket frames, exposing OpCode and continuation flag.
OnRawMessage	Fires before the component parses a message; set Handled to True to suppress default processing.

PubSub

Name	Description
OnSubscription	Fires when the client has been subscribed to a channel.
OnUnSubscription	Fires when the client has been unsubscribed from a channel.
OnEvent	Fires when a message is received on a subscribed channel.
OnAcknowledgment	Fires when the server acknowledges receipt of a QoS 1 or 2 message.

Dataset

Name	Description
OnBeforeNewRecord	Fires before a new record received from the server is inserted in the local Dataset.
OnAfterNewRecord	Fires after a new record received from the server has been inserted in the local Dataset.
OnBeforeUpdateRecord	Fires before an update received from the server is applied to the local Dataset.
OnAfterUpdateRecord	Fires after an update received from the server has been applied to the local Dataset.
OnBeforeDeleteRecord	Fires before a delete received from the server is applied to the local Dataset.
OnAfterDeleteRecord	Fires after a delete received from the server has been applied to the local Dataset.
OnBeforeDatasetUpdate	Fires before any Dataset message from the server is applied locally; set Handled to skip it.
OnBeforeSynchronize	Fires when the server announces the start of a Synchronize batch.
OnAfterSynchronize	Fires when the server signals that the Synchronize batch has ended.
OnMetaData	Fires when the server answers a GetMetaData request with the Dataset field definitions.

RPC

Name	Description
OnRPCResult	Fires when the server returns a successful RPC response.
OnRPCError	Fires when the server returns an error response to an RPC request.

All Events (alphabetical)

Name	Description
OnAcknowledgment	Fires when the server acknowledges receipt of a QoS 1 or 2 message.
OnAfterDeleteRecord	Fires after a delete received from the server has been applied to the local Dataset.
OnAfterNewRecord	Fires after a new record received from the server has been inserted in the local Dataset.
OnAfterSynchronize	Fires when the server signals that the Synchronize batch has ended.
OnAfterUpdateRecord	Fires after an update received from the server has been applied to the local Dataset.
OnBeforeDatasetUpdate	Fires before any Dataset message from the server is applied locally; set Handled to skip it.
OnBeforeDeleteRecord	Fires before a delete received from the server is applied to the local Dataset.
OnBeforeNewRecord	Fires before a new record received from the server is inserted in the local Dataset.
OnBeforeSynchronize	Fires when the server announces the start of a Synchronize batch.
OnBeforeUpdateRecord	Fires before an update received from the server is applied to the local Dataset.
OnBinary	Fires when a binary frame arrives; payload is delivered as a TMemoryStream.
OnConnect	Fires after the WebSocket handshake completes and the Dataset subprotocol is initialized.
OnDisconnect	Fires when the connection is closed, reporting the close code.
OnError	Fires when the server or transport reports an error string.
OnEvent	Fires when a message is received on a subscribed channel.
OnException	Fires when an unhandled exception occurs on the connection.
OnFragmented	Fires for fragmented WebSocket frames, exposing OpCode and continuation flag.
OnMessage	Fires when a plain text message arrives on the sgc channel.
OnMetaData	Fires when the server answers a GetMetaData request with the Dataset field definitions.
OnRawMessage	Fires before the component parses a message; set Handled to True to suppress default processing.
OnRPCError	Fires when the server returns an error response to an RPC request.
OnRPCResult	Fires when the server returns a successful RPC response.
OnSession	Fires after a successful connection or GetSession request with the assigned session Guid.
OnSubscription	Fires when the client has been subscribed to a channel.
OnUnSubscription	Fires when the client has been unsubscribed from a channel.