TsgcWSPClient_Dataset › Properties

TsgcWSPClient_Dataset Properties

Published properties grouped by purpose, followed by the full alphabetical list.

Connection

NameDescription
ClientWebSocket client component used as transport for the Dataset subprotocol.
BrokerOptional broker component that relays subprotocol messages between peers.
GuidUnique identifier used to route messages to a specific protocol instance.

Dataset

NameDescription
DataSetTDataSet instance that the component keeps in sync with the server.
AutoSubscribeSubscribe automatically to the internal Dataset channels after connecting.
NotifyUpdatesSend a message to the server each time the local Dataset changes.
ApplyUpdatesApply Dataset changes received from the server to the local Dataset.
UpdateModeSelects which fields are sent on update: all, changed, or full refresh.
FormatSettingsShared format settings used to serialize numeric and date/time fields.

Encoding

NameDescription
AutoEscapeTextAutomatically escape/unescape reserved characters inside string field values.
EncodeBase64Encode string field values in Base64 before sending them over the wire.

Messaging

NameDescription
QoSQuality of Service options (Level, Interval, Timeout) for acknowledged delivery.

Diagnostics

NameDescription
VersionRead-only subprotocol version string.

All Properties (alphabetical)

NameDescription
ApplyUpdatesApply Dataset changes received from the server to the local Dataset.
AutoEscapeTextAutomatically escape/unescape reserved characters inside string field values.
AutoSubscribeSubscribe automatically to the internal Dataset channels after connecting.
BrokerOptional broker component that relays subprotocol messages between peers.
ClientWebSocket client component used as transport for the Dataset subprotocol.
DataSetTDataSet instance that the component keeps in sync with the server.
EncodeBase64Encode string field values in Base64 before sending them over the wire.
FormatSettingsShared format settings used to serialize numeric and date/time fields.
GuidUnique identifier used to route messages to a specific protocol instance.
NotifyUpdatesSend a message to the server each time the local Dataset changes.
QoSQuality of Service options (Level, Interval, Timeout) for acknowledged delivery.
UpdateModeSelects which fields are sent on update: all, changed, or full refresh.
VersionRead-only subprotocol version string.