Package io.lettuce.core.api.sync
Interface BaseRedisCommands<K,V>
-
- Type Parameters:
K
- Key type.V
- Value type.
- All Known Subinterfaces:
RedisAdvancedClusterCommands<K,V>
,RedisClusterCommands<K,V>
,RedisClusterPubSubCommands<K,V>
,RedisCommands<K,V>
,RedisPubSubCommands<K,V>
public interface BaseRedisCommands<K,V>
Synchronous executed commands for basic commands.- Since:
- 4.0
- Author:
- Mark Paluch
- Generated class:
- by io.lettuce.apigenerator.CreateSyncApi
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description <T> T
dispatch(ProtocolKeyword type, CommandOutput<K,V,T> output)
Dispatch a command to the Redis Server.<T> T
dispatch(ProtocolKeyword type, CommandOutput<K,V,T> output, CommandArgs<K,V> args)
Dispatch a command to the Redis Server.V
echo(V msg)
Echo the given string.boolean
isOpen()
Deprecated.since 6.2.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()
Instructs Redis to disconnect 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.void
reset()
Deprecated.since 6.2.List<Object>
role()
Return the role of the instance in the context of replication.Long
waitForReplication(int replicas, long timeout)
Wait for replication.
-
-
-
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()
Instructs Redis to disconnect the connection. Note that if auto-reconnect is enabled then Lettuce will auto-reconnect if the connection was disconnected. UseStatefulConnection.close()
to close connections and release resources.- 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.
-
dispatch
<T> T dispatch(ProtocolKeyword type, CommandOutput<K,V,T> 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 benull
.output
- the command output, must not benull
.- Returns:
- the command response.
-
dispatch
<T> T dispatch(ProtocolKeyword type, CommandOutput<K,V,T> 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 benull
.output
- the command output, must not benull
.args
- the command arguments, must not benull
.- Returns:
- the command response.
-
isOpen
@Deprecated boolean isOpen()
Deprecated.since 6.2. Use the correspondingStatefulConnection.isOpen()
method on the connection interface. To be removed with Lettuce 7.0.- Returns:
true
if the connection is open (connected and not closed).
-
reset
@Deprecated void reset()
Deprecated.since 6.2. Use the correspondingStatefulConnection.reset()
method on the connection interface. To be removed with Lettuce 7.0.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.
-
-