io.lettuce.core.cluster.api.sync

Interface BaseNodeSelectionCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

NodeSelectionCommands<K,V>

public interface BaseNodeSelectionCommands<K,V>

Synchronous executed commands on a node selection for basic commands.

Since:

4.0

Author:

Mark Paluch

Generated class:

by io.lettuce.apigenerator.CreateSyncNodeSelectionClusterApi

Method Summary

Modifier and Type	Method and Description
Executions<V>	echo(V msg) Echo the given string.
Executions<String>	ping() Ping the server.
Executions<Long>	publish(K channel, V message) Post a message to a channel.
Executions<List<K>>	pubsubChannels() Lists the currently *active channels*.
Executions<List<K>>	pubsubChannels(K channel) Lists the currently *active channels*.
Executions<Long>	pubsubNumpat() Returns the number of subscriptions to patterns.
Executions<Map<K,Long>>	pubsubNumsub(K... channels) Returns the number of subscribers (not counting clients subscribed to patterns) for the specified channels.
Executions<String>	quit() Instructs Redis to disconnect the connection.
Executions<List<Object>>	role() Return the role of the instance in the context of replication.
Executions<Long>	waitForReplication(int replicas, long timeout) Wait for replication.

Method Detail

publish

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

Executions<List<K>> pubsubChannels()

Lists the currently *active channels*.

Returns:

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

pubsubChannels

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

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

Executions<Long> pubsubNumpat()

Returns the number of subscriptions to patterns.

Returns:

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

echo

Executions<V> echo(V msg)

Echo the given string.

Parameters:

msg - the message type: value.

Returns:

V bulk-string-reply.

role

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

Executions<String> ping()

Ping the server.

Returns:

String simple-string-reply.

quit

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

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

Wait for replication.

Parameters:

replicas - minimum number of replicas.

timeout - timeout in milliseconds.

Returns:

number of replicas.