web_socket_client library
Client library for CRDT Web Socket Sync
Classes
- AwarenessMessage
- base class for awareness messages
- AwarenessQueryMessage
- message to query the awareness state
- AwarenessStateMessage
- message with the awareness state
- AwarenessUpdateMessage
- message to update the awareness state
- ChangeMessage
- Message containing a CRDT change.
- ClientAwareness
- Client awareness state
- ClientAwarenessPlugin
- Client awareness plugin
-
CompressedCodec<
T> - Codec for messages with optional compression
- Compressor
- Interface for data compression
- CRDTSocketClient
- Interface for the CRDT client
- DocumentAwareness
- Document awareness state
- DocumentStatusMessage
- Message containing a full snapshot.
- DocumentStatusRequestMessage
- Snapshot request message sent from client to server.
- ErrorMessage
- Error message.
- HandshakeRequestMessage
- Handshake request message sent from client to server.
- HandshakeResponseMessage
- Handshake response message sent from server to client.
-
JsonMessageCodec<
T> - JSON message codec
- Message
- Base class for all messages exchanged between server and client.
-
MessageCodec<
T> - Interface for encoding and decoding messages
- MessageTypeValue
- base message type class
- NoCompression
- No compression implementation
- PingMessage
- Ping message to check the connection.
- PluginAwareMessageCodec
- A message codec that can be used to encode and decode messages for a list of MessageCodecs.
- PongMessage
- Pong message.
- Protocol
- Class that handles the communication protocol.
- SyncManager
- Manager for the CRDT client
- SyncPlugin
- Base class for all server and client plugins.
- Transport
- An interface for transporting messages, define the methods necessary to send and receive messages, independently from the underlying transport mechanism.
- TransportConnection
- An interface for transporting messages, define the methods necessary to send and receive messages, independently from the underlying transport mechanism.
- TransportConnector
- An interface for the transport connection
- WebSocketClient
- CRDTSocketClient implementation using web socket
Enums
- AwarenessMessageType
- Awareness message types
- ConnectionStatus
- Enum that represents the status of the connection
- MessageType
- Available message types
Mixins
- SocketClientProvider
- A provider that can provide the client instance.