WebSocketRelayServer constructor

WebSocketRelayServer({
  1. required Future<HttpServer> serverFactory(),
  2. RelayStore? store,
  3. RelayCompactionCoordinator? compaction,
  4. Compressor? compressor,
  5. MessageCodec<Message>? messageCodec,
  6. int? maxBufferSize,
  7. List<ServerSyncPlugin>? plugins,
})

WebSocket relay server implementation.

A relay server rebroadcasts opaque CRDT change blobs to the other clients of a room and persists them in a RelayStore, without ever interpreting CRDT data: merging is entirely a client concern. One server hosts many rooms, keyed by document id.

Constructor

Implementation

WebSocketRelayServer({
  required Future<HttpServer> Function() serverFactory,
  RelayStore? store,
  RelayCompactionCoordinator? compaction,
  Compressor? compressor,
  MessageCodec<Message>? messageCodec,
  int? maxBufferSize,
  List<ServerSyncPlugin>? plugins,
}) : this._(
        serverFactory: serverFactory,
        serverTransformer: DefaultWebSocketServerTransformer(),
        store: store,
        compaction: compaction,
        compressor: compressor,
        messageCodec: messageCodec,
        maxBufferSize: maxBufferSize,
        plugins: plugins,
      );