ServerAwarenessPlugin class

Server awareness plugin.

This plugin is used to manage the awareness of the clients connected to the same document.

Inheritance

Constructors

ServerAwarenessPlugin.new({MessageCodec<Message>? codec})
Constructor

Properties

hashCode → int
The hash code for this object.
no setterinherited
messageCodec → MessageCodec<Message>
The message codec for the plugin.
final
name → String
The name of the plugin.
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
server → CRDTSocketServer
The server instance.
no setterinherited

Methods

dispose() → void
Called when the plugin is disposed.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onDocumentRegistered(ClientSession session, String documentId) → void
Called when session subscribes to a new document.
override
onMessage(ClientSession session, Message message) → void
Called when a message is received from a client, after it has been decoded.
override
onNewSession(ClientSession session) → void
Called when a new client session is created.
override
onSessionClosed(ClientSession session) → void
Called when session is closed.
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited