Package net.carcdr.yhocuspocus.redis

Interface RedisClient

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

LettuceRedisClient

public interface RedisClient
extends AutoCloseable

Abstract interface for Redis operations used by the Redis extension.

This interface abstracts the underlying Redis client library (Lettuce, Jedis, etc.) to allow different implementations and easier testing.

Implementations must be thread-safe.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the client and releases resources.
CompletableFuture<Void>	delete(String key)	Deletes a key.
CompletableFuture<byte[]>	get(String key)	Gets a binary value by key.
boolean	isConnected()	Checks if the client is connected.
CompletableFuture<Void>	publish(String channel, byte[] message)	Publishes a message to a channel.
CompletableFuture<Void>	set(String key, byte[] value)	Sets a binary value by key.
CompletableFuture<Void>	subscribe(String channel, BiConsumer<String,byte[]> handler)	Subscribes to a channel.
CompletableFuture<Void>	unsubscribe(String channel)	Unsubscribes from a channel.

Method Details

publish

CompletableFuture<Void> publish(String channel,
 byte[] message)

Publishes a message to a channel.

Parameters:

channel - the channel to publish to

message - the message bytes

Returns:

a future that completes when the message is sent

subscribe

CompletableFuture<Void> subscribe(String channel,
 BiConsumer<String,byte[]> handler)

Subscribes to a channel.

Parameters:

channel - the channel to subscribe to

handler - callback for received messages (channel, message)

Returns:

a future that completes when subscribed

unsubscribe

CompletableFuture<Void> unsubscribe(String channel)

Unsubscribes from a channel.

Parameters:

channel - the channel to unsubscribe from

Returns:

a future that completes when unsubscribed

get

CompletableFuture<byte[]> get(String key)

Gets a binary value by key.

Parameters:

key - the key

Returns:

a future containing the value, or null if not found

set

CompletableFuture<Void> set(String key,
 byte[] value)

Sets a binary value by key.

Parameters:

key - the key

value - the value

Returns:

a future that completes when set

delete

CompletableFuture<Void> delete(String key)

Deletes a key.

Parameters:

key - the key to delete

Returns:

a future that completes when deleted

isConnected

boolean isConnected()

Checks if the client is connected.

Returns:

true if connected

close

void close()

Closes the client and releases resources.

Specified by:

close in interface AutoCloseable