com.lambdaworks.redis

Interface BaseRedisAsyncConnection<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

RedisAsyncConnection<K,V>, RedisClusterAsyncConnection<K,V>, RedisPubSubConnection<K,V>

All Known Implementing Classes:

RedisAsyncConnectionImpl, RedisPubSubConnectionImpl

public interface BaseRedisAsyncConnection<K,V>
extends Closeable

Basic asynchronous 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.
RedisFuture<String>	discard() Discard all commands issued after MULTI.
RedisFuture<V>	echo(V msg) Echo the given string.
RedisFuture<List<Object>>	exec() Execute all commands issued after MULTI.
boolean	isOpen()
RedisFuture<String>	multi() Mark the start of a transaction block.
RedisFuture<String>	ping() Ping the server.
RedisFuture<Long>	publish(K channel, V message) Post a message to a channel.
RedisFuture<List<K>>	pubsubChannels() Lists the currently *active channels*.
RedisFuture<List<K>>	pubsubChannels(K channel) Lists the currently *active channels*.
RedisFuture<Long>	pubsubNumpat() Returns the number of subscriptions to patterns.
RedisFuture<Map<K,Long>>	pubsubNumsub(K... channels) Returns the number of subscribers (not counting clients subscribed to patterns) for the specified channels.
RedisFuture<String>	quit() Close the connection.
RedisFuture<List<Object>>	role() Return the role of the instance in the context of replication.
RedisFuture<String>	unwatch() Forget about all watched keys.
RedisFuture<Long>	waitForReplication(int replicas, long timeout) Wait for replication.
RedisFuture<String>	watch(K... keys) Watch the given keys to determine execution of the MULTI/EXEC block.

Method Detail

publish

RedisFuture<Long> publish(K channel,
                          V message)

Post a message to a channel.

Parameters:

channel - the channel type: key

message - the message type: value

Returns:

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

pubsubChannels

RedisFuture<List<K>> pubsubChannels()

Lists the currently *active channels*.

Returns:

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

pubsubChannels

RedisFuture<List<K>> pubsubChannels(K channel)

Lists the currently *active channels*.

Parameters:

channel - the key

Returns:

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

pubsubNumsub

RedisFuture<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

RedisFuture<Long> pubsubNumpat()

Returns the number of subscriptions to patterns.

Returns:

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

echo

RedisFuture<V> echo(V msg)

Echo the given string.

Parameters:

msg - the message type: value

Returns:

RedisFuture<V> bulk-string-reply

role

RedisFuture<List<Object>> role()

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

Returns:

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

ping

RedisFuture<String> ping()

Ping the server.

Returns:

RedisFuture<String> simple-string-reply

quit

RedisFuture<String> quit()

Close the connection.

Returns:

RedisFuture<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

RedisFuture<String> discard()

Discard all commands issued after MULTI.

Returns:

RedisFuture<String> simple-string-reply always OK.

exec

RedisFuture<List<Object>> exec()

Execute all commands issued after MULTI.

Returns:

RedisFuture<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

RedisFuture<String> multi()

Mark the start of a transaction block.

Returns:

RedisFuture<String> simple-string-reply always OK.

watch

RedisFuture<String> watch(K... keys)

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

Parameters:

keys - the key

Returns:

RedisFuture<String> simple-string-reply always OK.

unwatch

RedisFuture<String> unwatch()

Forget about all watched keys.

Returns:

RedisFuture<String> simple-string-reply always OK.

waitForReplication

RedisFuture<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).