ServerSyncPlugin class abstract
Base class for all server plugins.
extends
(not implements) this class to make the plugin work.
Once the plugin is attached to the server the CRDTSocketServer
will
be available.
A plugin can be used to extend the server functionality. It can handle custom messages, and listen to events from the server.
- Implemented types
- Mixed-in types
- Implementers
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
-
messageCodec
→ MessageCodec<
Message> -
The message codec for the plugin.
no setterinherited
- name → String
-
The name of the plugin.
no setterinherited
- 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.
inherited
-
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. -
onMessage(
ClientSession session, Message message) → void - Called when a message is received from a client, after it has been decoded.
-
onNewSession(
ClientSession session) → void - Called when a new client session is created.
-
onSessionClosed(
ClientSession session) → void -
Called when
session
is closed. -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited