TsgcWSPServer_Dataset

This is Server Protocol Dataset Component, you need to drop this component in the form and select a TsgcWebSocketServer Component using Server Property and select a Dataset Component using Dataset Property.

 

This component inherits from TsgcWSProtocol_Server_sgc all methods and properties.

Properties

    ApplyUpdates: if enabled, every time the server receives a dataset update from client, it will be saved on the server side.

 

    NotifyUpdates: if enabled, every time dataset server changes, server broadcasts this change to all connected clients.

 

    NotifyDeletes: if enabled, every time a record is deleted, server broadcasts this to all connected clients.

 

    AutoEscapeText: if enabled (disabled by default), automatically escape/unescape characters inside field values like "{", "["...

 

    AutoSynchronize: if enabled, every time a client connects to the server, the server will send metadata and all dataset records to client.

 

    FormatSettings: allows to set the format of double and datetime fields (to avoid conflicts between diffferent format settings of peers). This format must be the same for server and clients.

 

    UpdateMode:

 

 

Methods

    BroadcastRecord: sends dataset record values to all connected clients.

 

    MetaData: sends metadata info to a client.

 

    Synchronize: sends all dataset records to a client.

 

Events

  These events are specific on the dataset protocol.

 

  OnAfterDeleteRecord: event fired after a record is deleted from Dataset.

 

  OnAfterNewRecord: event fired after a record is created on Dataset.

 

  OnAfterUpdateRecord: event fired after a record is updated on Dataset.

 

  OnBeforeDeleteRecord: event fired before a record is deleted from Dataset. If Argument "Handled" is True, means that the user handles this event and if won't be deleted (by default this argument is False)

 

  OnBeforeNewRecord: event fired before a record is created on Dataset. If Argument "Handled" is True, means that the user handles this event and if won't be inserted (by default this argument is False)

 

  OnBeforeUpdateRecord: event fired before a record is updated on Dataset.  If Argument "Handled" is True, means that the user handles this event and if won't be updated (by default this argument is False)

 

  OnBeforeDatasetUpdate: event fired before a dataset record is updated.