com.lambdaworks.redis.api.rx

Interface BaseRedisReactiveCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

RedisAdvancedClusterReactiveCommands<K,V>, RedisClusterPubSubReactiveCommands<K,V>, RedisClusterReactiveCommands<K,V>, RedisPubSubReactiveCommands<K,V>, RedisReactiveCommands<K,V>

All Known Implementing Classes:

AbstractRedisReactiveCommands, RedisAdvancedClusterReactiveCommandsImpl, RedisPubSubReactiveCommandsImpl, RedisReactiveCommandsImpl

public interface BaseRedisReactiveCommands<K,V>
extends AutoCloseable

Observable commands for basic commands.

Since:

4.0

Author:

Mark Paluch

Generated class:

by com.lambdaworks.apigenerator.CreateReactiveApi

Method Summary

Modifier and Type	Method and Description
void	close() Close the connection.
<T> Observable<T>	dispatch(ProtocolKeyword type, CommandOutput<K,V,?> output) Dispatch a command to the Redis Server.
<T> Observable<T>	dispatch(ProtocolKeyword type, CommandOutput<K,V,?> output, CommandArgs<K,V> args) Dispatch a command to the Redis Server.
Observable<V>	echo(V msg) Echo the given string.
boolean	isOpen()
Observable<String>	ping() Ping the server.
Observable<Long>	publish(K channel, V message) Post a message to a channel.
Observable<K>	pubsubChannels() Lists the currently *active channels*.
Observable<K>	pubsubChannels(K channel) Lists the currently *active channels*.
Observable<Long>	pubsubNumpat() Returns the number of subscriptions to patterns.
Observable<Map<K,Long>>	pubsubNumsub(K... channels) Returns the number of subscribers (not counting clients subscribed to patterns) for the specified channels.
Observable<String>	quit() Instructs Redis to disconnect the connection.
Observable<String>	readOnly() Switch connection to Read-Only mode when connecting to a cluster.
Observable<String>	readWrite() Switch connection to Read-Write mode (default) when connecting to a cluster.
void	reset() Reset the command state.
Observable<Object>	role() Return the role of the instance in the context of replication.
Observable<Long>	waitForReplication(int replicas, long timeout) Wait for replication.

Method Detail

publish

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

Observable<K> pubsubChannels()

Lists the currently *active channels*.

Returns:

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

pubsubChannels

Observable<K> pubsubChannels(K channel)

Lists the currently *active channels*.

Parameters:

channel - the key

Returns:

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

pubsubNumsub

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

Observable<Long> pubsubNumpat()

Returns the number of subscriptions to patterns.

Returns:

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

echo

Observable<V> echo(V msg)

Echo the given string.

Parameters:

msg - the message type: value

Returns:

V bulk-string-reply

role

Observable<Object> role()

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

Returns:

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

ping

Observable<String> ping()

Ping the server.

Returns:

String simple-string-reply

readOnly

Observable<String> readOnly()

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

Returns:

String simple-string-reply.

readWrite

Observable<String> readWrite()

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

Returns:

String simple-string-reply.

quit

Observable<String> quit()

Instructs Redis to disconnect the connection. Note that if auto-reconnect is enabled then Lettuce will auto-reconnect if the connection was disconnected. Use StatefulConnection.close() to close connections and release resources.

Returns:

String simple-string-reply always OK.

waitForReplication

Observable<Long> waitForReplication(int replicas,
                                    long timeout)

Wait for replication.

Parameters:

replicas - minimum number of replicas

timeout - timeout in milliseconds

Returns:

number of replicas

dispatch

<T> Observable<T> dispatch(ProtocolKeyword type,
                           CommandOutput<K,V,?> output)

Dispatch a command to the Redis Server. Please note the command output type must fit to the command response.

Type Parameters:

T - response type

Parameters:

type - the command, must not be null.

output - the command output, must not be null.

Returns:

the command response

dispatch

<T> Observable<T> dispatch(ProtocolKeyword type,
                           CommandOutput<K,V,?> output,
                           CommandArgs<K,V> args)

Dispatch a command to the Redis Server. Please note the command output type must fit to the command response.

Type Parameters:

T - response type

Parameters:

type - the command, must not be null.

output - the command output, must not be null.

args - the command arguments, must not be null.

Returns:

the command response

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

isOpen

boolean isOpen()

Returns:

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

reset

void reset()

Reset the command state. Queued commands will be canceled and the internal state will be reset. This is useful when the internal state machine gets out of sync with the connection.