BaseRedisReactiveCommands (Lettuce 6.5.3.RELEASE API)

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

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

All Known Implementing Classes:

AbstractRedisReactiveCommands, RedisAdvancedClusterReactiveCommandsImpl, RedisClusterPubSubReactiveCommandsImpl, RedisPubSubReactiveCommandsImpl, RedisReactiveCommandsImpl, RedisSentinelReactiveCommandsImpl
```
public interface BaseRedisReactiveCommands<K,V>
```
Reactive executed commands for basic commands.

Since:

4.0

Author:

Mark Paluch, Ali Takavci

Generated class:

by io.lettuce.apigenerator.CreateReactiveApi

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`<T> Flux<T>`	`dispatch(ProtocolKeyword type, CommandOutput<K,V,?> output)` Dispatch a command to the Redis Server.
`<T> Flux<T>`	`dispatch(ProtocolKeyword type, CommandOutput<K,V,?> output, CommandArgs<K,V> args)` Dispatch a command to the Redis Server.
`Mono<V>`	`echo(V msg)` Echo the given string.
`void`	`flushCommands()` Deprecated. since 6.2. Use the corresponding `StatefulConnection.flushCommands()` method on the connection interface. To be removed with Lettuce 7.0.
`JsonParser`	`getJsonParser()`
`boolean`	`isOpen()` Deprecated. since 6.2. Use the corresponding `StatefulConnection.isOpen()` method on the connection interface. To be removed with Lettuce 7.0.
`Mono<String>`	`ping()` Ping the server.
`Mono<Long>`	`publish(K channel, V message)` Post a message to a channel.
`Flux<K>`	`pubsubChannels()` Lists the currently active channels.
`Flux<K>`	`pubsubChannels(K channel)` Lists the currently active channels.
`Mono<Long>`	`pubsubNumpat()` Returns the number of subscriptions to patterns.
`Mono<Map<K,Long>>`	`pubsubNumsub(K... channels)` Returns the number of subscribers (not counting clients subscribed to patterns) for the specified channels.
`Flux<K>`	`pubsubShardChannels()` Lists the currently active shard channels.
`Flux<K>`	`pubsubShardChannels(K pattern)` Lists the currently active shard channels.
`Mono<Map<K,Long>>`	`pubsubShardNumsub(K... shardChannels)` Returns the number of subscribers (not counting clients subscribed to patterns) for the specified shard channels.
`Mono<String>`	`quit()` Instructs Redis to disconnect the connection.
`Mono<String>`	`readOnly()` Switch connection to Read-Only mode when connecting to a cluster.
`Mono<String>`	`readWrite()` Switch connection to Read-Write mode (default) when connecting to a cluster.
`void`	`reset()` Deprecated. since 6.2. Use the corresponding `StatefulConnection.reset()` method on the connection interface. To be removed with Lettuce 7.0.
`Flux<Object>`	`role()` Return the role of the instance in the context of replication.
`void`	`setAutoFlushCommands(boolean autoFlush)` Deprecated. since 6.2. Use the corresponding `StatefulConnection.setAutoFlushCommands(boolean)` method on the connection interface. To be removed with Lettuce 7.0.
`Mono<Long>`	`spublish(K shardChannel, V message)` Post a message to a shard channel.
`Mono<Long>`	`waitForReplication(int replicas, long timeout)` Wait for replication.

- Method Detail
  - publish
```
Mono<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
```
Flux<K> pubsubChannels()
```
    Lists the currently *active channels*.
    
    Returns:
    
    K array-reply a list of active channels, optionally matching the specified pattern.
  - pubsubChannels
```
Flux<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
```
Mono<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.
  - pubsubShardChannels
```
Flux<K> pubsubShardChannels()
```
    Lists the currently *active shard channels*.
    
    Returns:
    
    K array-reply a list of active channels.
  - pubsubShardChannels
```
Flux<K> pubsubShardChannels(K pattern)
```
    Lists the currently *active shard channels*.
    
    Parameters:
    
    pattern - the pattern type: patternkey (pattern).
    
    Returns:
    
    K array-reply a list of active channels, optionally matching the specified pattern.
  - pubsubShardNumsub
```
Mono<Map<K,Long>> pubsubShardNumsub(K... shardChannels)
```
    Returns the number of subscribers (not counting clients subscribed to patterns) for the specified shard channels.
    
    Parameters:
    
    shardChannels - channel keys.
    
    Returns:
    
    array-reply a list of channels and number of subscribers for every channel.
    
    Since:
    
    6.4
  - pubsubNumpat
```
Mono<Long> pubsubNumpat()
```
    Returns the number of subscriptions to patterns.
    
    Returns:
    
    Long integer-reply the number of patterns all the clients are subscribed to.
  - spublish
```
Mono<Long> spublish(K shardChannel,
                    V message)
```
    Post a message to a shard channel.
    
    Parameters:
    
    shardChannel - the shard channel type: key.
    
    message - the message type: value.
    
    Returns:
    
    Long integer-reply the number of clients that received the message.
    
    Since:
    
    6.4
  - echo
```
Mono<V> echo(V msg)
```
    Echo the given string.
    
    Parameters:
    
    msg - the message type: value.
    
    Returns:
    
    V bulk-string-reply.
  - role
```
Flux<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
```
Mono<String> ping()
```
    Ping the server.
    
    Returns:
    
    String simple-string-reply.
  - readOnly
```
Mono<String> readOnly()
```
    Switch connection to Read-Only mode when connecting to a cluster.
    
    Returns:
    
    String simple-string-reply.
  - readWrite
```
Mono<String> readWrite()
```
    Switch connection to Read-Write mode (default) when connecting to a cluster.
    
    Returns:
    
    String simple-string-reply.
  - quit
```
Mono<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
```
Mono<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> Flux<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> Flux<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.
  - isOpen
```
@Deprecated
boolean isOpen()
```
    Deprecated. since 6.2. Use the corresponding StatefulConnection.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 corresponding StatefulConnection.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.
  - setAutoFlushCommands
```
@Deprecated
void setAutoFlushCommands(boolean autoFlush)
```
    Deprecated. since 6.2. Use the corresponding StatefulConnection.setAutoFlushCommands(boolean) method on the connection interface. To be removed with Lettuce 7.0.
    
    Disable or enable auto-flush behavior. Default is true. If autoFlushCommands is disabled, multiple commands can be issued without writing them actually to the transport. Commands are buffered until a flushCommands() is issued. After calling flushCommands() commands are sent to the transport and executed by Redis.
    
    Parameters:
    
    autoFlush - state of autoFlush.
  - flushCommands
```
@Deprecated
void flushCommands()
```
    Deprecated. since 6.2. Use the corresponding StatefulConnection.flushCommands() method on the connection interface. To be removed with Lettuce 7.0.
    
    Flush pending commands. This commands forces a flush on the channel and can be used to buffer ("pipeline") commands to achieve batching. No-op if channel is not connected.
  - getJsonParser
```
JsonParser getJsonParser()
```
    Returns:
    
    the currently configured instance of the JsonParser
    
    Since:
    
    6.5

Interface BaseRedisReactiveCommands<K,V>

Method Summary

Method Detail

publish

pubsubChannels

pubsubChannels

pubsubNumsub

pubsubShardChannels

pubsubShardChannels

pubsubShardNumsub

pubsubNumpat

spublish

echo

role

ping

readOnly

readWrite

quit

waitForReplication

dispatch

dispatch

isOpen

reset

setAutoFlushCommands

flushCommands

getJsonParser