TsgcWSPServer_Dataset › Properties

TsgcWSPServer_Dataset Properties

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

Server

NameDescription
ServerWebSocket server component used as transport for the Dataset subprotocol.
BrokerOptional broker component that relays subprotocol messages between servers.
GuidUnique identifier used to route messages to a specific server-side protocol instance.

Dataset

NameDescription
DataSetTDataSet instance whose rows the server publishes to connected clients.
AutoSynchronizeSend metadata and a full dataset snapshot automatically as soon as a client connects.
NotifyUpdatesBroadcast inserts and updates to connected clients whenever the server dataset posts a record.
ApplyUpdatesApply client-originated insert, update and delete messages to the server dataset.
UpdateModeStrategy used to match an incoming update against a row in the server dataset.
FormatSettingsDate, time and numeric format settings used when serialising field values.

Encoding

NameDescription
AutoEscapeTextEscape special JSON characters in text fields before they are placed in the envelope.
EncodeBase64Encode string and blob field values as Base64 to protect non-ASCII or binary payloads.

Security

NameDescription
RPCAuthenticationOptional allow-list of RPC methods and matching users required to execute them.

Diagnostics

NameDescription
VersionRead-only subprotocol version string.

All Properties (alphabetical)

NameDescription
ApplyUpdatesApply client-originated insert, update and delete messages to the server dataset.
AutoEscapeTextEscape special JSON characters in text fields before they are placed in the envelope.
AutoSynchronizeSend metadata and a full dataset snapshot automatically as soon as a client connects.
BrokerOptional broker component that relays subprotocol messages between servers.
DataSetTDataSet instance whose rows the server publishes to connected clients.
EncodeBase64Encode string and blob field values as Base64 to protect non-ASCII or binary payloads.
FormatSettingsDate, time and numeric format settings used when serialising field values.
GuidUnique identifier used to route messages to a specific server-side protocol instance.
NotifyUpdatesBroadcast inserts and updates to connected clients whenever the server dataset posts a record.
RPCAuthenticationOptional allow-list of RPC methods and matching users required to execute them.
ServerWebSocket server component used as transport for the Dataset subprotocol.
UpdateModeStrategy used to match an incoming update against a row in the server dataset.
VersionRead-only subprotocol version string.