Index
All Classes and Interfaces|All Packages
A
- afterLoadDocument(AfterLoadDocumentPayload) - Method in class net.carcdr.yhocuspocus.redis.RedisPubSubExtension
- awarenessChannel(String) - Method in class net.carcdr.yhocuspocus.redis.RedisExtensionConfig
-
Generates the channel name for awareness updates.
- awarenessEnabled(boolean) - Method in class net.carcdr.yhocuspocus.redis.RedisExtensionConfig.Builder
-
Enables or disables cross-instance awareness sync.
- awarenessThrottle(Duration) - Method in class net.carcdr.yhocuspocus.redis.RedisExtensionConfig.Builder
-
Sets the minimum interval between awareness updates.
- AwarenessThrottler - Class in net.carcdr.yhocuspocus.redis
-
Throttles awareness updates to prevent excessive Redis traffic.
- AwarenessThrottler(Duration) - Constructor for class net.carcdr.yhocuspocus.redis.AwarenessThrottler
-
Creates a new throttler with the specified minimum interval.
B
- beforeUnloadDocument(BeforeUnloadDocumentPayload) - Method in class net.carcdr.yhocuspocus.redis.RedisPubSubExtension
- build() - Method in class net.carcdr.yhocuspocus.redis.RedisExtensionConfig.Builder
-
Builds the configuration.
- builder() - Static method in class net.carcdr.yhocuspocus.redis.RedisExtensionConfig
-
Creates a new builder for RedisExtensionConfig.
C
- clear() - Method in class net.carcdr.yhocuspocus.redis.AwarenessThrottler
-
Clears all tracking state.
- close() - Method in class net.carcdr.yhocuspocus.redis.LettuceRedisClient
- close() - Method in interface net.carcdr.yhocuspocus.redis.RedisClient
-
Closes the client and releases resources.
D
- decode(byte[]) - Static method in class net.carcdr.yhocuspocus.redis.MessageCodec
-
Decodes a message, extracting the instance ID.
- DecodedMessage(String, byte[]) - Constructor for record class net.carcdr.yhocuspocus.redis.MessageCodec.DecodedMessage
-
Creates an instance of a
DecodedMessagerecord class. - defaults() - Static method in class net.carcdr.yhocuspocus.redis.RedisExtensionConfig
-
Creates a default configuration.
- delete(String) - Method in class net.carcdr.yhocuspocus.redis.LettuceRedisClient
- delete(String) - Method in interface net.carcdr.yhocuspocus.redis.RedisClient
-
Deletes a key.
- documentChannel(String) - Method in class net.carcdr.yhocuspocus.redis.RedisExtensionConfig
-
Generates the channel name for document updates.
E
- encode(String, byte[]) - Static method in class net.carcdr.yhocuspocus.redis.MessageCodec
-
Encodes a message with instance ID prefix.
- equals(Object) - Method in record class net.carcdr.yhocuspocus.redis.MessageCodec.DecodedMessage
-
Indicates whether some other object is "equal to" this one.
G
- get(String) - Method in class net.carcdr.yhocuspocus.redis.LettuceRedisClient
- get(String) - Method in interface net.carcdr.yhocuspocus.redis.RedisClient
-
Gets a binary value by key.
- getAwarenessThrottle() - Method in class net.carcdr.yhocuspocus.redis.RedisExtensionConfig
-
Gets the minimum interval between awareness updates.
- getConfig() - Method in class net.carcdr.yhocuspocus.redis.RedisPubSubExtension
-
Gets the configuration for this extension.
- getInstanceId() - Method in class net.carcdr.yhocuspocus.redis.RedisExtensionConfig
-
Gets the unique instance ID for this server.
- getPrefix() - Method in class net.carcdr.yhocuspocus.redis.RedisExtensionConfig
-
Gets the key prefix for Redis keys.
- getSubscribedDocuments() - Method in class net.carcdr.yhocuspocus.redis.RedisPubSubExtension
-
Gets the set of currently subscribed document names.
- getTrackedCount() - Method in class net.carcdr.yhocuspocus.redis.AwarenessThrottler
-
Gets the number of documents being tracked.
H
- hashCode() - Method in record class net.carcdr.yhocuspocus.redis.MessageCodec.DecodedMessage
-
Returns a hash code value for this object.
I
- instanceId() - Method in record class net.carcdr.yhocuspocus.redis.MessageCodec.DecodedMessage
-
Returns the value of the
instanceIdrecord component. - instanceId(String) - Method in class net.carcdr.yhocuspocus.redis.RedisExtensionConfig.Builder
-
Sets the unique instance ID for this server.
- isAwarenessEnabled() - Method in class net.carcdr.yhocuspocus.redis.RedisExtensionConfig
-
Checks if cross-instance awareness sync is enabled.
- isConnected() - Method in class net.carcdr.yhocuspocus.redis.LettuceRedisClient
- isConnected() - Method in interface net.carcdr.yhocuspocus.redis.RedisClient
-
Checks if the client is connected.
- isConnected() - Method in class net.carcdr.yhocuspocus.redis.RedisPubSubExtension
-
Checks if the Redis client is connected.
- isFrom(String) - Method in record class net.carcdr.yhocuspocus.redis.MessageCodec.DecodedMessage
-
Checks if this message originated from the given instance.
L
- LettuceRedisClient - Class in net.carcdr.yhocuspocus.redis
-
Redis client implementation using Lettuce.
- LettuceRedisClient(RedisClient) - Constructor for class net.carcdr.yhocuspocus.redis.LettuceRedisClient
-
Creates a new Lettuce-based Redis client from an existing Lettuce client.
- LettuceRedisClient(RedisURI) - Constructor for class net.carcdr.yhocuspocus.redis.LettuceRedisClient
-
Creates a new Lettuce-based Redis client.
- LettuceRedisClient(String, int) - Constructor for class net.carcdr.yhocuspocus.redis.LettuceRedisClient
-
Creates a new Lettuce-based Redis client.
M
- MessageCodec - Class in net.carcdr.yhocuspocus.redis
-
Encodes and decodes Redis messages with instance ID prefix.
- MessageCodec.DecodedMessage - Record Class in net.carcdr.yhocuspocus.redis
-
A decoded message containing instance ID and payload.
N
- net.carcdr.yhocuspocus.redis - package net.carcdr.yhocuspocus.redis
O
- onChange(OnChangePayload) - Method in class net.carcdr.yhocuspocus.redis.RedisPubSubExtension
- onDestroy(OnDestroyPayload) - Method in class net.carcdr.yhocuspocus.redis.RedisPubSubExtension
- onStoreDocument(OnStoreDocumentPayload) - Method in class net.carcdr.yhocuspocus.redis.RedisPubSubExtension
P
- payload() - Method in record class net.carcdr.yhocuspocus.redis.MessageCodec.DecodedMessage
-
Returns the value of the
payloadrecord component. - prefix(String) - Method in class net.carcdr.yhocuspocus.redis.RedisExtensionConfig.Builder
-
Sets the Redis key prefix.
- priority() - Method in class net.carcdr.yhocuspocus.redis.RedisPubSubExtension
- publish(String, byte[]) - Method in class net.carcdr.yhocuspocus.redis.LettuceRedisClient
- publish(String, byte[]) - Method in interface net.carcdr.yhocuspocus.redis.RedisClient
-
Publishes a message to a channel.
R
- RedisClient - Interface in net.carcdr.yhocuspocus.redis
-
Abstract interface for Redis operations used by the Redis extension.
- RedisExtensionConfig - Class in net.carcdr.yhocuspocus.redis
-
Configuration for Redis extensions.
- RedisExtensionConfig.Builder - Class in net.carcdr.yhocuspocus.redis
-
Builder for RedisExtensionConfig.
- RedisPubSubExtension - Class in net.carcdr.yhocuspocus.redis
-
Redis extension for horizontal scaling using pub/sub.
- RedisPubSubExtension(RedisExtensionConfig, RedisClient) - Constructor for class net.carcdr.yhocuspocus.redis.RedisPubSubExtension
-
Creates a new Redis pub/sub extension.
- remove(String) - Method in class net.carcdr.yhocuspocus.redis.AwarenessThrottler
-
Removes tracking for a document.
S
- set(String, byte[]) - Method in class net.carcdr.yhocuspocus.redis.LettuceRedisClient
- set(String, byte[]) - Method in interface net.carcdr.yhocuspocus.redis.RedisClient
-
Sets a binary value by key.
- stateKey(String) - Method in class net.carcdr.yhocuspocus.redis.RedisExtensionConfig
-
Generates the key for document state storage.
- subscribe(String, BiConsumer<String, byte[]>) - Method in class net.carcdr.yhocuspocus.redis.LettuceRedisClient
- subscribe(String, BiConsumer<String, byte[]>) - Method in interface net.carcdr.yhocuspocus.redis.RedisClient
-
Subscribes to a channel.
T
- toString() - Method in record class net.carcdr.yhocuspocus.redis.MessageCodec.DecodedMessage
-
Returns a string representation of this record class.
- tryAcquire(String) - Method in class net.carcdr.yhocuspocus.redis.AwarenessThrottler
-
Attempts to acquire permission to send an awareness update.
U
- unsubscribe(String) - Method in class net.carcdr.yhocuspocus.redis.LettuceRedisClient
- unsubscribe(String) - Method in interface net.carcdr.yhocuspocus.redis.RedisClient
-
Unsubscribes from a channel.
V
- vectorKey(String) - Method in class net.carcdr.yhocuspocus.redis.RedisExtensionConfig
-
Generates the key for document state vector storage.
All Classes and Interfaces|All Packages