Index

A B C D E F G H I L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages

A

ACTIVE - Enum constant in enum class net.carcdr.yhocuspocus.core.YDocument.State

Document is active and accepting connections.

addConnection(DocumentConnection) - Method in class net.carcdr.yhocuspocus.core.YDocument

Adds a connection to this document.

afterLoadDocument(AfterLoadDocumentPayload) - Method in interface net.carcdr.yhocuspocus.extension.Extension

Called after a document has been loaded.

AfterLoadDocumentPayload - Class in net.carcdr.yhocuspocus.extension

Payload for the afterLoadDocument hook.

AfterLoadDocumentPayload(YDocument, Map<String, Object>) - Constructor for class net.carcdr.yhocuspocus.extension.AfterLoadDocumentPayload

Creates a new after-load payload.

afterStoreDocument(AfterStoreDocumentPayload) - Method in interface net.carcdr.yhocuspocus.extension.Extension

Called after a document has been stored.

AfterStoreDocumentPayload - Class in net.carcdr.yhocuspocus.extension

Payload for the afterStoreDocument hook.

AfterStoreDocumentPayload(YDocument, Map<String, Object>) - Constructor for class net.carcdr.yhocuspocus.extension.AfterStoreDocumentPayload

Creates a new after-store payload.

afterUnloadDocument(AfterUnloadDocumentPayload) - Method in interface net.carcdr.yhocuspocus.extension.Extension

Called after a document has been unloaded.

AfterUnloadDocumentPayload - Class in net.carcdr.yhocuspocus.extension

Payload for the afterUnloadDocument hook.

AfterUnloadDocumentPayload(String) - Constructor for class net.carcdr.yhocuspocus.extension.AfterUnloadDocumentPayload

Creates a new after-unload payload.

applySyncMessage(YDoc, byte[]) - Static method in class net.carcdr.yhocuspocus.protocol.SyncProtocol

Applies a sync message to a document.

applyUpdate(byte[], String) - Method in class net.carcdr.yhocuspocus.protocol.Awareness

Applies an awareness update.

AUTH - Enum constant in enum class net.carcdr.yhocuspocus.protocol.MessageType

Authentication message.

awareness(String, byte[]) - Static method in class net.carcdr.yhocuspocus.protocol.OutgoingMessage

Creates an AWARENESS message.

Awareness - Class in net.carcdr.yhocuspocus.protocol

Awareness protocol for tracking user presence.

Awareness(YDoc) - Constructor for class net.carcdr.yhocuspocus.protocol.Awareness

Creates a new awareness instance.

AWARENESS - Enum constant in enum class net.carcdr.yhocuspocus.protocol.MessageType

Awareness update (user presence, cursor position, selection).

B

beforeUnloadDocument(BeforeUnloadDocumentPayload) - Method in interface net.carcdr.yhocuspocus.extension.Extension

Called before a document is unloaded from memory.

BeforeUnloadDocumentPayload - Class in net.carcdr.yhocuspocus.extension

Payload for the beforeUnloadDocument hook.

BeforeUnloadDocumentPayload(YDocument) - Constructor for class net.carcdr.yhocuspocus.extension.BeforeUnloadDocumentPayload

Creates a new before-unload payload.

broadcast(byte[], String) - Method in class net.carcdr.yhocuspocus.core.YDocument

Broadcasts a message to all connections except sender.

BROADCAST_STATELESS - Enum constant in enum class net.carcdr.yhocuspocus.protocol.MessageType

Broadcast stateless custom message to all clients.

broadcastStateless(String, String) - Method in class net.carcdr.yhocuspocus.core.YDocument

Broadcasts a stateless message to all connections except sender.

broadcastStateless(String, String) - Static method in class net.carcdr.yhocuspocus.protocol.OutgoingMessage

Creates a BROADCAST_STATELESS message.

broadcastToAll(byte[]) - Method in class net.carcdr.yhocuspocus.core.YDocument

Broadcasts to all connections including sender.

build() - Method in class net.carcdr.yhocuspocus.core.YHocuspocus.Builder

Builds the YHocuspocus instance.

builder() - Static method in class net.carcdr.yhocuspocus.core.YHocuspocus

Creates a new builder.

Builder() - Constructor for class net.carcdr.yhocuspocus.core.YHocuspocus.Builder

C

cancelSave(String) - Method in class net.carcdr.yhocuspocus.util.DebouncedDocumentSaver

Cancels any pending save for a document.

clear() - Method in class net.carcdr.yhocuspocus.extension.InMemoryDatabaseExtension

Clears all stored documents.

ClientConnection - Class in net.carcdr.yhocuspocus.core

Manages a client transport connection.

close() - Method in class net.carcdr.yhocuspocus.core.ClientConnection

close() - Method in class net.carcdr.yhocuspocus.core.DocumentConnection

Closes this document connection.

close() - Method in class net.carcdr.yhocuspocus.core.YDocument

close() - Method in class net.carcdr.yhocuspocus.core.YHocuspocus

close() - Method in interface net.carcdr.yhocuspocus.transport.Transport

Closes the transport with default parameters.

close(int, String) - Method in class net.carcdr.yhocuspocus.core.ClientConnection

Closes this connection.

close(int, String) - Method in interface net.carcdr.yhocuspocus.transport.Transport

Closes the transport connection.

CLOSE - Enum constant in enum class net.carcdr.yhocuspocus.protocol.MessageType

Graceful connection close.

CLOSED - Enum constant in enum class net.carcdr.yhocuspocus.core.YDocument.State

Document is closed and cannot be used.

createTransport(T, TransportMessageHandler, TransportEventHandler) - Method in interface net.carcdr.yhocuspocus.transport.TransportFactory

Creates a transport from a raw connection.

D

DatabaseExtension - Class in net.carcdr.yhocuspocus.extension

Abstract base class for database persistence extensions.

DatabaseExtension() - Constructor for class net.carcdr.yhocuspocus.extension.DatabaseExtension

debounce(Duration) - Method in class net.carcdr.yhocuspocus.core.YHocuspocus.Builder

Sets the debounce duration (quiet period before save).

DebouncedDocumentSaver - Class in net.carcdr.yhocuspocus.util

Debounced document persistence scheduler.

DebouncedDocumentSaver(ScheduledExecutorService, Duration, Duration) - Constructor for class net.carcdr.yhocuspocus.util.DebouncedDocumentSaver

Creates a new debounced document saver.

decode(byte[]) - Static method in class net.carcdr.yhocuspocus.protocol.MessageDecoder

Decodes a binary message.

DocumentConnection - Class in net.carcdr.yhocuspocus.core

Represents a connection to a specific document.

E

encode() - Method in class net.carcdr.yhocuspocus.protocol.OutgoingMessage

Encodes this message to binary format.

encodeSyncStep1(byte[]) - Static method in class net.carcdr.yhocuspocus.protocol.SyncProtocol

Encodes a SyncStep1 message.

encodeSyncStep2(byte[]) - Static method in class net.carcdr.yhocuspocus.protocol.SyncProtocol

Encodes a SyncStep2 message.

encodeUpdate(byte[]) - Static method in class net.carcdr.yhocuspocus.protocol.SyncProtocol

Encodes an Update message.

extension(Extension) - Method in class net.carcdr.yhocuspocus.core.YHocuspocus.Builder

Adds an extension to the server.

Extension - Interface in net.carcdr.yhocuspocus.extension

Extension interface for customizing server behavior.

F

fromValue(int) - Static method in enum class net.carcdr.yhocuspocus.protocol.MessageType

Converts a numeric value to a message type.

G

getAwareness() - Method in class net.carcdr.yhocuspocus.core.YDocument

Gets the awareness instance.

getClientCount() - Method in class net.carcdr.yhocuspocus.protocol.Awareness

Gets the number of active clients.

getConnectionCount() - Method in class net.carcdr.yhocuspocus.core.YDocument

Gets connection count.

getConnectionId() - Method in class net.carcdr.yhocuspocus.core.ClientConnection

Gets the connection ID.

getConnectionId() - Method in class net.carcdr.yhocuspocus.core.DocumentConnection

Gets the connection ID.

getConnectionId() - Method in class net.carcdr.yhocuspocus.extension.OnAuthenticatePayload

Gets the connection identifier.

getConnectionId() - Method in class net.carcdr.yhocuspocus.extension.OnConnectPayload

Gets the unique connection identifier.

getConnectionId() - Method in class net.carcdr.yhocuspocus.extension.OnDisconnectPayload

Gets the connection identifier.

getConnectionId() - Method in interface net.carcdr.yhocuspocus.transport.Transport

Gets a unique identifier for this transport connection.

getContext() - Method in class net.carcdr.yhocuspocus.core.ClientConnection

Gets the connection context.

getContext() - Method in class net.carcdr.yhocuspocus.extension.AfterLoadDocumentPayload

Gets the connection context.

getContext() - Method in class net.carcdr.yhocuspocus.extension.AfterStoreDocumentPayload

Gets the connection context.

getContext() - Method in class net.carcdr.yhocuspocus.extension.OnAuthenticatePayload

Gets the connection context.

getContext() - Method in class net.carcdr.yhocuspocus.extension.OnChangePayload

Gets the connection context.

getContext() - Method in class net.carcdr.yhocuspocus.extension.OnConnectPayload

Gets the connection context.

getContext() - Method in class net.carcdr.yhocuspocus.extension.OnCreateDocumentPayload

Gets the connection context.

getContext() - Method in class net.carcdr.yhocuspocus.extension.OnDisconnectPayload

Gets the connection context.

getContext() - Method in class net.carcdr.yhocuspocus.extension.OnLoadDocumentPayload

Gets the connection context.

getContext() - Method in class net.carcdr.yhocuspocus.extension.OnStoreDocumentPayload

Gets the connection context.

getDoc() - Method in class net.carcdr.yhocuspocus.core.YDocument

Gets the underlying YDoc.

getDocument() - Method in class net.carcdr.yhocuspocus.core.DocumentConnection

Gets the document.

getDocument() - Method in class net.carcdr.yhocuspocus.extension.AfterLoadDocumentPayload

Gets the loaded document.

getDocument() - Method in class net.carcdr.yhocuspocus.extension.AfterStoreDocumentPayload

Gets the stored document.

getDocument() - Method in class net.carcdr.yhocuspocus.extension.BeforeUnloadDocumentPayload

Gets the document being unloaded.

getDocument() - Method in class net.carcdr.yhocuspocus.extension.OnChangePayload

Gets the document that changed.

getDocument() - Method in class net.carcdr.yhocuspocus.extension.OnCreateDocumentPayload

Gets the document being created.

getDocument() - Method in class net.carcdr.yhocuspocus.extension.OnLoadDocumentPayload

Gets the document being loaded.

getDocument() - Method in class net.carcdr.yhocuspocus.extension.OnStoreDocumentPayload

Gets the document to store.

getDocument(String) - Method in class net.carcdr.yhocuspocus.core.YHocuspocus

Gets a document by name (if loaded).

getDocumentCount() - Method in class net.carcdr.yhocuspocus.core.YHocuspocus

Gets the number of loaded documents.

getDocumentCount() - Method in class net.carcdr.yhocuspocus.extension.InMemoryDatabaseExtension

Gets the number of stored documents.

getDocumentName() - Method in class net.carcdr.yhocuspocus.extension.AfterUnloadDocumentPayload

Gets the name of the unloaded document.

getDocumentName() - Method in class net.carcdr.yhocuspocus.extension.BeforeUnloadDocumentPayload

Gets the document name.

getDocumentName() - Method in class net.carcdr.yhocuspocus.extension.OnAuthenticatePayload

Gets the document name being accessed.

getDocumentName() - Method in class net.carcdr.yhocuspocus.extension.OnStoreDocumentPayload

Gets the document name.

getDocumentName() - Method in class net.carcdr.yhocuspocus.protocol.IncomingMessage

Gets the document name from the message.

getDocumentName() - Method in class net.carcdr.yhocuspocus.protocol.OutgoingMessage

Gets the document name.

getExtensions() - Method in class net.carcdr.yhocuspocus.core.YHocuspocus

Gets the list of extensions.

getName() - Method in class net.carcdr.yhocuspocus.core.YDocument

Gets the document name.

getOrCreateDocument(String, Map<String, Object>) - Method in class net.carcdr.yhocuspocus.core.YHocuspocus

Creates or retrieves a document.

getPayload() - Method in class net.carcdr.yhocuspocus.protocol.IncomingMessage

Gets the message payload.

getPayload() - Method in class net.carcdr.yhocuspocus.protocol.OutgoingMessage

Gets the payload.

getPendingSaveCount() - Method in class net.carcdr.yhocuspocus.util.DebouncedDocumentSaver

Gets the number of pending saves.

getPosition() - Method in class net.carcdr.yhocuspocus.protocol.VarIntReader

Gets the current read position.

getRawData() - Method in class net.carcdr.yhocuspocus.protocol.IncomingMessage

Gets the original raw message data.

getRemoteAddress() - Method in interface net.carcdr.yhocuspocus.transport.Transport

Gets the remote address/identifier for this connection.

getState() - Method in class net.carcdr.yhocuspocus.core.YDocument

Gets the current lifecycle state.

getState() - Method in class net.carcdr.yhocuspocus.extension.OnLoadDocumentPayload

Gets the loaded state.

getState() - Method in class net.carcdr.yhocuspocus.extension.OnStoreDocumentPayload

Gets the full document state.

getState(long) - Method in class net.carcdr.yhocuspocus.protocol.Awareness

Gets awareness state for a specific client.

getStatelessPayload() - Method in class net.carcdr.yhocuspocus.protocol.IncomingMessage

Gets the stateless message payload as a string.

getStates() - Method in class net.carcdr.yhocuspocus.protocol.Awareness

Gets all awareness states.

getToken() - Method in class net.carcdr.yhocuspocus.extension.OnAuthenticatePayload

Gets the authentication token.

getToken() - Method in class net.carcdr.yhocuspocus.protocol.IncomingMessage

Gets the authentication token from AUTH messages.

getTransport() - Method in class net.carcdr.yhocuspocus.core.ClientConnection

Gets the transport.

getType() - Method in class net.carcdr.yhocuspocus.protocol.IncomingMessage

Gets the message type.

getType() - Method in class net.carcdr.yhocuspocus.protocol.OutgoingMessage

Gets the message type.

getUpdate() - Method in class net.carcdr.yhocuspocus.extension.OnChangePayload

Gets the update bytes.

getValue() - Method in enum class net.carcdr.yhocuspocus.protocol.MessageType

Gets the numeric value of this message type.

H

handleConnection(Transport, Map<String, Object>) - Method in class net.carcdr.yhocuspocus.core.YHocuspocus

Handles a new transport connection.

handleDisconnect(String, Map<String, Object>) - Method in class net.carcdr.yhocuspocus.core.YHocuspocus

Handles client disconnection.

handleDocumentChange(YDocument, Map<String, Object>, byte[]) - Method in class net.carcdr.yhocuspocus.core.YHocuspocus

Handles document changes (triggers onChange, broadcasts update, and schedules save).

handleMessage(IncomingMessage) - Method in class net.carcdr.yhocuspocus.core.DocumentConnection

Handles a message for this document.

hasChanges(byte[]) - Static method in class net.carcdr.yhocuspocus.protocol.SyncProtocol

Checks if a sync message contains changes.

hasDocument(String) - Method in class net.carcdr.yhocuspocus.extension.InMemoryDatabaseExtension

Checks if a document exists in storage.

hasPendingSave(String) - Method in class net.carcdr.yhocuspocus.util.DebouncedDocumentSaver

Checks if a save is pending for a document.

hasRemaining() - Method in class net.carcdr.yhocuspocus.protocol.VarIntReader

Checks if there are more bytes to read.

I

IncomingMessage - Class in net.carcdr.yhocuspocus.protocol

Represents an incoming message from a client.

IncomingMessage(String, MessageType, byte[], byte[]) - Constructor for class net.carcdr.yhocuspocus.protocol.IncomingMessage

Creates a new incoming message.

InMemoryDatabaseExtension - Class in net.carcdr.yhocuspocus.extension

In-memory database extension for testing and development.

InMemoryDatabaseExtension() - Constructor for class net.carcdr.yhocuspocus.extension.InMemoryDatabaseExtension

Creates a new in-memory database extension.

isOpen() - Method in interface net.carcdr.yhocuspocus.transport.Transport

Checks if the transport is open and ready to send messages.

isReadOnly() - Method in class net.carcdr.yhocuspocus.core.DocumentConnection

Checks if this connection is read-only.

isReadOnly() - Method in class net.carcdr.yhocuspocus.extension.OnAuthenticatePayload

Checks if connection should be read-only.

isValid() - Method in enum class net.carcdr.yhocuspocus.protocol.MessageType

Checks if this is a valid message type (not UNKNOWN).

L

loadFromDatabase(String) - Method in class net.carcdr.yhocuspocus.extension.DatabaseExtension

Loads document state from the persistence layer.

loadFromDatabase(String) - Method in class net.carcdr.yhocuspocus.extension.InMemoryDatabaseExtension

Loads document state from memory.

LOADING - Enum constant in enum class net.carcdr.yhocuspocus.core.YDocument.State

Document is being loaded from storage.

M

maxDebounce(Duration) - Method in class net.carcdr.yhocuspocus.core.YHocuspocus.Builder

Sets the maximum debounce duration (force save after).

MessageDecoder - Class in net.carcdr.yhocuspocus.protocol

Decoder for incoming binary messages.

MessageType - Enum Class in net.carcdr.yhocuspocus.protocol

Message types for Y-CRDT synchronization protocol.

N

net.carcdr.yhocuspocus.core - package net.carcdr.yhocuspocus.core

net.carcdr.yhocuspocus.extension - package net.carcdr.yhocuspocus.extension

net.carcdr.yhocuspocus.protocol - package net.carcdr.yhocuspocus.protocol

net.carcdr.yhocuspocus.transport - package net.carcdr.yhocuspocus.transport

net.carcdr.yhocuspocus.util - package net.carcdr.yhocuspocus.util

O

onAuthenticate(OnAuthenticatePayload) - Method in interface net.carcdr.yhocuspocus.extension.Extension

Called when a client attempts to authenticate for a document.

OnAuthenticatePayload - Class in net.carcdr.yhocuspocus.extension

Payload for the onAuthenticate hook.

OnAuthenticatePayload(String, String, String, Map<String, Object>) - Constructor for class net.carcdr.yhocuspocus.extension.OnAuthenticatePayload

Creates a new authentication payload.

onChange(OnChangePayload) - Method in interface net.carcdr.yhocuspocus.extension.Extension

Called when a document is modified.

OnChangePayload - Class in net.carcdr.yhocuspocus.extension

Payload for the onChange hook.

OnChangePayload(YDocument, Map<String, Object>, byte[]) - Constructor for class net.carcdr.yhocuspocus.extension.OnChangePayload

Creates a new change payload.

onClose(Transport, int, String) - Method in interface net.carcdr.yhocuspocus.transport.TransportEventHandler

Called when a transport connection closes.

onConnect(OnConnectPayload) - Method in interface net.carcdr.yhocuspocus.extension.Extension

Called when a client connection is established.

OnConnectPayload - Class in net.carcdr.yhocuspocus.extension

Payload for the onConnect hook.

OnConnectPayload(String, Map<String, Object>) - Constructor for class net.carcdr.yhocuspocus.extension.OnConnectPayload

Creates a new connection payload.

onCreateDocument(OnCreateDocumentPayload) - Method in interface net.carcdr.yhocuspocus.extension.Extension

Called when a document is first created (before loading).

OnCreateDocumentPayload - Class in net.carcdr.yhocuspocus.extension

Payload for the onCreateDocument hook.

OnCreateDocumentPayload(YDocument, Map<String, Object>) - Constructor for class net.carcdr.yhocuspocus.extension.OnCreateDocumentPayload

Creates a new document creation payload.

onDestroy(OnDestroyPayload) - Method in interface net.carcdr.yhocuspocus.extension.Extension

Called when the server is shutting down.

OnDestroyPayload - Class in net.carcdr.yhocuspocus.extension

Payload for the onDestroy hook.

OnDestroyPayload() - Constructor for class net.carcdr.yhocuspocus.extension.OnDestroyPayload

Creates a new destroy payload.

onDisconnect(OnDisconnectPayload) - Method in interface net.carcdr.yhocuspocus.extension.Extension

Called when a client connection is closed.

OnDisconnectPayload - Class in net.carcdr.yhocuspocus.extension

Payload for the onDisconnect hook.

OnDisconnectPayload(String, Map<String, Object>) - Constructor for class net.carcdr.yhocuspocus.extension.OnDisconnectPayload

Creates a new disconnect payload.

onError(Transport, Throwable) - Method in interface net.carcdr.yhocuspocus.transport.TransportEventHandler

Called when a transport error occurs.

onLoadDocument(OnLoadDocumentPayload) - Method in class net.carcdr.yhocuspocus.extension.DatabaseExtension

Loads document state from the database.

onLoadDocument(OnLoadDocumentPayload) - Method in interface net.carcdr.yhocuspocus.extension.Extension

Called when a document needs to be loaded from persistence.

OnLoadDocumentPayload - Class in net.carcdr.yhocuspocus.extension

Payload for the onLoadDocument hook.

OnLoadDocumentPayload(YDocument, Map<String, Object>) - Constructor for class net.carcdr.yhocuspocus.extension.OnLoadDocumentPayload

Creates a new document load payload.

onMessage(byte[]) - Method in class net.carcdr.yhocuspocus.core.ClientConnection

Called by the transport when a binary message is received.

onMessage(byte[]) - Method in interface net.carcdr.yhocuspocus.transport.ReceiveListener

Called when the transport receives a binary message.

onMessage(Transport, byte[]) - Method in interface net.carcdr.yhocuspocus.transport.TransportMessageHandler

Handles an incoming message from a transport.

onOpen(Transport) - Method in interface net.carcdr.yhocuspocus.transport.TransportEventHandler

Called when a transport connection opens.

onStoreDocument(OnStoreDocumentPayload) - Method in class net.carcdr.yhocuspocus.extension.DatabaseExtension

Persists document state to the database.

onStoreDocument(OnStoreDocumentPayload) - Method in interface net.carcdr.yhocuspocus.extension.Extension

Called when a document should be persisted.

OnStoreDocumentPayload - Class in net.carcdr.yhocuspocus.extension

Payload for the onStoreDocument hook.

OnStoreDocumentPayload(YDocument, Map<String, Object>, byte[]) - Constructor for class net.carcdr.yhocuspocus.extension.OnStoreDocumentPayload

Creates a new store document payload.

OutgoingMessage - Class in net.carcdr.yhocuspocus.protocol

Represents an outgoing message to a client.

P

priority() - Method in class net.carcdr.yhocuspocus.extension.DatabaseExtension

Extension priority for database operations.

priority() - Method in interface net.carcdr.yhocuspocus.extension.Extension

Extension priority (higher = runs earlier).

Q

QUERY_AWARENESS - Enum constant in enum class net.carcdr.yhocuspocus.protocol.MessageType

Query awareness request (ask for current awareness states).

R

readBytes(int) - Method in class net.carcdr.yhocuspocus.protocol.VarIntReader

Reads a specific number of bytes.

readVarBytes() - Method in class net.carcdr.yhocuspocus.protocol.VarIntReader

Reads a variable-length byte array.

readVarInt() - Method in class net.carcdr.yhocuspocus.protocol.VarIntReader

Reads a variable-length unsigned integer.

readVarString() - Method in class net.carcdr.yhocuspocus.protocol.VarIntReader

Reads a variable-length string.

ReceiveListener - Interface in net.carcdr.yhocuspocus.transport

Listener for receiving messages from a transport.

remaining() - Method in class net.carcdr.yhocuspocus.protocol.VarIntReader

Returns all remaining bytes from the current position.

remainingBytes() - Method in class net.carcdr.yhocuspocus.protocol.VarIntReader

Gets the number of bytes remaining to read.

removeConnection(DocumentConnection) - Method in class net.carcdr.yhocuspocus.core.YDocument

Removes a connection from this document.

removeDocument(String) - Method in class net.carcdr.yhocuspocus.extension.InMemoryDatabaseExtension

Removes a document from storage.

removeStates(long[]) - Method in class net.carcdr.yhocuspocus.protocol.Awareness

Removes awareness states for disconnected clients.

reset() - Method in class net.carcdr.yhocuspocus.protocol.VarIntReader

Resets the reader to the beginning.

reset() - Method in class net.carcdr.yhocuspocus.protocol.VarIntWriter

Resets the writer, clearing all written data.

S

saveImmediately(String, Runnable) - Method in class net.carcdr.yhocuspocus.util.DebouncedDocumentSaver

Forces immediate save, bypassing debounce logic.

saveToDatabase(String, byte[]) - Method in class net.carcdr.yhocuspocus.extension.DatabaseExtension

Saves document state to the persistence layer.

saveToDatabase(String, byte[]) - Method in class net.carcdr.yhocuspocus.extension.InMemoryDatabaseExtension

Saves document state to memory.

schedulerThreads(int) - Method in class net.carcdr.yhocuspocus.core.YHocuspocus.Builder

Sets the number of scheduler threads.

scheduleSave(String, Runnable) - Method in class net.carcdr.yhocuspocus.util.DebouncedDocumentSaver

Schedules a save with debouncing.

send(byte[]) - Method in class net.carcdr.yhocuspocus.core.ClientConnection

Sends a message via transport.

send(byte[]) - Method in class net.carcdr.yhocuspocus.core.DocumentConnection

Sends a message via client connection.

send(byte[]) - Method in interface net.carcdr.yhocuspocus.transport.Transport

Sends a binary message to the client.

setReadOnly(boolean) - Method in class net.carcdr.yhocuspocus.core.DocumentConnection

Sets read-only mode.

setReadOnly(boolean) - Method in class net.carcdr.yhocuspocus.extension.OnAuthenticatePayload

Sets whether the connection should be read-only.

setReceiveListener(ReceiveListener) - Method in interface net.carcdr.yhocuspocus.transport.Transport

Sets the listener for receiving messages from this transport.

setState(byte[]) - Method in class net.carcdr.yhocuspocus.extension.OnLoadDocumentPayload

Sets the document state to be loaded.

size() - Method in class net.carcdr.yhocuspocus.protocol.VarIntWriter

Returns the current size in bytes.

stateless(String, String) - Static method in class net.carcdr.yhocuspocus.protocol.OutgoingMessage

Creates a STATELESS message.

STATELESS - Enum constant in enum class net.carcdr.yhocuspocus.protocol.MessageType

Stateless custom message to server.

sync(String, byte[]) - Static method in class net.carcdr.yhocuspocus.protocol.OutgoingMessage

Creates a SYNC message.

SYNC - Enum constant in enum class net.carcdr.yhocuspocus.protocol.MessageType

Sync protocol message (Y.js sync step 1, step 2, or update).

SYNC_REPLY - Enum constant in enum class net.carcdr.yhocuspocus.protocol.MessageType

Sync reply message (deprecated, use SYNC).

SYNC_STATUS - Enum constant in enum class net.carcdr.yhocuspocus.protocol.MessageType

Sync status acknowledgment.

SyncProtocol - Class in net.carcdr.yhocuspocus.protocol

Y.js sync protocol implementation.

syncReply(String, byte[]) - Static method in class net.carcdr.yhocuspocus.protocol.OutgoingMessage

Creates a SYNC_REPLY message (deprecated, use sync instead).

syncStatus(String, boolean) - Static method in class net.carcdr.yhocuspocus.protocol.OutgoingMessage

Creates a SYNC_STATUS message.

T

toByteArray() - Method in class net.carcdr.yhocuspocus.protocol.VarIntWriter

Returns the encoded bytes.

toString() - Method in class net.carcdr.yhocuspocus.protocol.IncomingMessage

toString() - Method in class net.carcdr.yhocuspocus.protocol.OutgoingMessage

Transport - Interface in net.carcdr.yhocuspocus.transport

Abstraction for transport mechanisms (WebSocket, HTTP, SSE, etc.).

TransportEventHandler - Interface in net.carcdr.yhocuspocus.transport

Handler for transport lifecycle events.

TransportFactory<T> - Interface in net.carcdr.yhocuspocus.transport

Factory for creating transport instances from raw connections.

TransportMessageHandler - Interface in net.carcdr.yhocuspocus.transport

Handler for incoming transport messages.

U

UNKNOWN - Enum constant in enum class net.carcdr.yhocuspocus.protocol.MessageType

Unknown or invalid message type.

unloadDocument(String) - Method in class net.carcdr.yhocuspocus.core.YHocuspocus

Unloads a document from memory.

UNLOADING - Enum constant in enum class net.carcdr.yhocuspocus.core.YDocument.State

Document is being unloaded (no new connections).

V

valueOf(String) - Static method in enum class net.carcdr.yhocuspocus.core.YDocument.State

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class net.carcdr.yhocuspocus.protocol.MessageType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class net.carcdr.yhocuspocus.core.YDocument.State

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class net.carcdr.yhocuspocus.protocol.MessageType

Returns an array containing the constants of this enum class, in the order they are declared.

VarIntReader - Class in net.carcdr.yhocuspocus.protocol

Variable-length integer reader compatible with lib0 encoding.

VarIntReader(byte[]) - Constructor for class net.carcdr.yhocuspocus.protocol.VarIntReader

Creates a new variable-length integer reader.

VarIntWriter - Class in net.carcdr.yhocuspocus.protocol

Variable-length integer writer compatible with lib0 encoding.

VarIntWriter() - Constructor for class net.carcdr.yhocuspocus.protocol.VarIntWriter

Creates a new variable-length integer writer.

W

withSaveLock(Runnable) - Method in class net.carcdr.yhocuspocus.core.YDocument

Executes code with save lock held.

writeBytes(byte[]) - Method in class net.carcdr.yhocuspocus.protocol.VarIntWriter

Writes raw bytes without any encoding.

writeVarBytes(byte[]) - Method in class net.carcdr.yhocuspocus.protocol.VarIntWriter

Writes a variable-length byte array.

writeVarInt(long) - Method in class net.carcdr.yhocuspocus.protocol.VarIntWriter

Writes a variable-length unsigned integer.

writeVarString(String) - Method in class net.carcdr.yhocuspocus.protocol.VarIntWriter

Writes a variable-length string.

Y

YDocument - Class in net.carcdr.yhocuspocus.core

Wraps a Y.Doc with connection management and awareness.

YDocument.State - Enum Class in net.carcdr.yhocuspocus.core

Document lifecycle states.

YHocuspocus - Class in net.carcdr.yhocuspocus.core

Main collaborative editing server orchestrator.

YHocuspocus.Builder - Class in net.carcdr.yhocuspocus.core

Builder for YHocuspocus.

A B C D E F G H I L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages