TinyBase logoTinyBase

WsSynchronizer

The WsSynchronizer interface represents a Synchronizer that lets you synchronize MergeableStore data to and from other MergeableStore instances via WebSockets facilitated by a server.

You should use the createWsSynchronizer function to create a WsSynchronizer object.

It is a minor extension to the Synchronizer interface and simply provides an extra getWebSocket method for accessing a reference to the WebSocket being used.

Since

v5.0.0

Getter methods

This is the collection of getter methods within the WsSynchronizer interface. There are only two getter methods, getStore and getWebSocket.

Lifecycle methods

This is the collection of lifecycle methods within the WsSynchronizer interface. There are only two lifecycle methods, destroy and schedule.

Load methods

This is the collection of load methods within the WsSynchronizer interface. There are 4 load methods in total.

Save methods

This is the collection of save methods within the WsSynchronizer interface. There are 4 save methods in total.

Synchronization methods

This is the collection of synchronization methods within the WsSynchronizer interface. There are only three synchronization methods, getSynchronizerStats, startSync, and stopSync.

Development methods

This is the collection of development methods within the WsSynchronizer interface. There is only one method, getStats.