com.lambdaworks.redis

Interface BaseRedisConnection<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

RedisAdvancedClusterConnection<K,V>, RedisClusterConnection<K,V>, RedisConnection<K,V>

public interface BaseRedisConnection<K,V>
extends Closeable

Basic synchronous executed commands.

Since:

3.0

Author:

Mark Paluch

Method Summary

Modifier and Type	Method and Description
void	close() Close the connection.
String	digest(V script) Create a SHA1 digest from a Lua script.
String	discard() Discard all commands issued after MULTI.
V	echo(V msg) Echo the given string.
List<Object>	exec() Execute all commands issued after MULTI.
boolean	isOpen()
String	multi() Mark the start of a transaction block.
String	ping() Ping the server.
Long	publish(K channel, V message) Post a message to a channel.
List<K>	pubsubChannels() Lists the currently *active channels*.
List<K>	pubsubChannels(K channel) Lists the currently *active channels*.
Long	pubsubNumpat() Returns the number of subscriptions to patterns.
Map<K,Long>	pubsubNumsub(K... channels) Returns the number of subscribers (not counting clients subscribed to patterns) for the specified channels.
String	quit() Close the connection.
String	readOnly() Switch connection to Read-Only mode when connecting to a cluster.
String	readWrite() Switch connection to Read-Write mode (default) when connecting to a cluster.
List<Object>	role() Return the role of the instance in the context of replication.
String	unwatch() Forget about all watched keys.
Long	waitForReplication(int replicas, long timeout) Wait for replication.
String	watch(K... keys) Watch the given keys to determine execution of the MULTI/EXEC block.

Method Detail

publish

Long publish(K channel,
             V message)

Post a message to a channel.

Parameters:

channel - the channel type: key

message - the message type: value

Returns:

Long integer-reply the number of clients that received the message.

pubsubChannels

List<K> pubsubChannels()

Lists the currently *active channels*.

Returns:

List<K> array-reply a list of active channels, optionally matching the specified pattern.

pubsubChannels

List<K> pubsubChannels(K channel)

Lists the currently *active channels*.

Parameters:

channel - the key

Returns:

List<K> array-reply a list of active channels, optionally matching the specified pattern.

pubsubNumsub

Map<K,Long> pubsubNumsub(K... channels)

Returns the number of subscribers (not counting clients subscribed to patterns) for the specified channels.

Parameters:

channels - channel keys

Returns:

array-reply a list of channels and number of subscribers for every channel.

pubsubNumpat

Long pubsubNumpat()

Returns the number of subscriptions to patterns.

Returns:

Long integer-reply the number of patterns all the clients are subscribed to.

echo

V echo(V msg)

Echo the given string.

Parameters:

msg - the message type: value

Returns:

V bulk-string-reply

role

List<Object> role()

Return the role of the instance in the context of replication.

Returns:

List<Object> array-reply where the first element is one of master, slave, sentinel and the additional elements are role-specific.

ping

String ping()

Ping the server.

Returns:

String simple-string-reply

readOnly

String readOnly()

Switch connection to Read-Only mode when connecting to a cluster.

Returns:

String simple-string-reply.

readWrite

String readWrite()

Switch connection to Read-Write mode (default) when connecting to a cluster.

Returns:

String simple-string-reply.

quit

String quit()

Close the connection.

Returns:

String simple-string-reply always OK.

digest

String digest(V script)

Create a SHA1 digest from a Lua script.

Parameters:

script - script content

Returns:

the SHA1 value

discard

String discard()

Discard all commands issued after MULTI.

Returns:

String simple-string-reply always OK.

exec

List<Object> exec()

Execute all commands issued after MULTI.

Returns:

List<Object> array-reply each element being the reply to each of the commands in the atomic transaction. When using WATCH, EXEC can return a

multi

String multi()

Mark the start of a transaction block.

Returns:

String simple-string-reply always OK.

watch

String watch(K... keys)

Watch the given keys to determine execution of the MULTI/EXEC block.

Parameters:

keys - the key

Returns:

String simple-string-reply always OK.

unwatch

String unwatch()

Forget about all watched keys.

Returns:

String simple-string-reply always OK.

waitForReplication

Long waitForReplication(int replicas,
                        long timeout)

Wait for replication.

Parameters:

replicas - minimum number of replicas

timeout - timeout in milliseconds

Returns:

number of replicas

close

void close()

Close the connection. The connection will become not usable anymore as soon as this method was called.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

isOpen

boolean isOpen()

Returns:

true if the connection is open (connected and not closed).