Package net.carcdr.yhocuspocus.redis

Class RedisExtensionConfig

java.lang.Object

net.carcdr.yhocuspocus.redis.RedisExtensionConfig

public final class RedisExtensionConfig
extends Object

Configuration for Redis extensions.

Use the builder pattern to create instances:

 RedisExtensionConfig config = RedisExtensionConfig.builder()
     .prefix("myapp")
     .instanceId("instance-1")
     .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RedisExtensionConfig.Builder	Builder for RedisExtensionConfig.

Method Summary

Modifier and Type	Method	Description
String	awarenessChannel(String documentName)	Generates the channel name for awareness updates.
static RedisExtensionConfig.Builder	builder()	Creates a new builder for RedisExtensionConfig.
static RedisExtensionConfig	defaults()	Creates a default configuration.
String	documentChannel(String documentName)	Generates the channel name for document updates.
Duration	getAwarenessThrottle()	Gets the minimum interval between awareness updates.
String	getInstanceId()	Gets the unique instance ID for this server.
String	getPrefix()	Gets the key prefix for Redis keys.
boolean	isAwarenessEnabled()	Checks if cross-instance awareness sync is enabled.
String	stateKey(String documentName)	Generates the key for document state storage.
String	vectorKey(String documentName)	Generates the key for document state vector storage.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static RedisExtensionConfig.Builder builder()

Creates a new builder for RedisExtensionConfig.

Returns:

a new builder

defaults

public static RedisExtensionConfig defaults()

Creates a default configuration.

Returns:

default configuration

getPrefix

public String getPrefix()

Gets the key prefix for Redis keys.

Returns:

the prefix

getInstanceId

public String getInstanceId()

Gets the unique instance ID for this server.

Returns:

the instance ID

getAwarenessThrottle

public Duration getAwarenessThrottle()

Gets the minimum interval between awareness updates.

Returns:

the throttle duration

isAwarenessEnabled

public boolean isAwarenessEnabled()

Checks if cross-instance awareness sync is enabled.

Returns:

true if awareness sync is enabled

documentChannel

public String documentChannel(String documentName)

Generates the channel name for document updates.

Parameters:

documentName - the document name

Returns:

the channel name

awarenessChannel

public String awarenessChannel(String documentName)

Generates the channel name for awareness updates.

Parameters:

documentName - the document name

Returns:

the awareness channel name

stateKey

public String stateKey(String documentName)

Generates the key for document state storage.

Parameters:

documentName - the document name

Returns:

the state key

vectorKey

public String vectorKey(String documentName)

Generates the key for document state vector storage.

Parameters:

documentName - the document name

Returns:

the state vector key