LettuceRedisPubSubConnection (TORO Martini 1.10.3 API)

java.lang.Object
- io.toro.martini.database.LettuceRedisPubSubConnection<K,V>

All Implemented Interfaces:

StatefulConnection<K,V>, StatefulRedisConnection<K,V>, AsyncCloseable, StatefulRedisPubSubConnection<K,V>, Connection, AutoCloseable
```
public class LettuceRedisPubSubConnection<K,V>
extends Object
implements StatefulRedisPubSubConnection<K,V>
```

Constructor Summary

Constructors
Constructor and Description
`LettuceRedisPubSubConnection(org.apache.commons.pool2.impl.GenericObjectPool<StatefulRedisPubSubConnection<K,V>> connectionPool, RedisDatabase config)`
`LettuceRedisPubSubConnection(StatefulRedisConnection<K,V> connection, RedisDatabase config)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(RedisPubSubListener<K,V> listener)`
`RedisPubSubAsyncCommands<K,V>`	`async()`
`void`	`close()`
`CompletableFuture<Void>`	`closeAsync()`
`(package private) static <K,V> LettuceRedisPubSubConnection<K,V>`	`create(org.apache.commons.pool2.impl.GenericObjectPool<StatefulRedisPubSubConnection<K,V>> connectionPool, RedisDatabase config)`
`(package private) static <K,V> LettuceRedisPubSubConnection<K,V>`	`create(StatefulRedisPubSubConnection<K,V> connection, RedisDatabase config)`
`Collection<RedisCommand<K,V,?>>`	`dispatch(Collection<? extends RedisCommand<K,V,?>> collection)`
`<T> RedisCommand<K,V,T>`	`dispatch(RedisCommand<K,V,T> command)`
`void`	`flushCommands()`
`C`	`getDelegate()`
`ClientOptions`	`getOptions()`
`ClientResources`	`getResources()`
`Duration`	`getTimeout()`
`boolean`	`isMulti()`
`boolean`	`isOpen()`
`boolean`	`isValid(long timeOut, TimeUnit unit)` Pings the Redis server provided by `RedisDatabase.uri()`
`RedisPubSubReactiveCommands<K,V>`	`reactive()`
`void`	`removeListener(RedisPubSubListener<K,V> listener)`
`void`	`reset()`
`void`	`setAutoFlushCommands(boolean autoFlush)`
`void`	`setTimeout(Duration timeout)`
`void`	`setTimeout(long timeout, TimeUnit unit)`
`RedisPubSubCommands<K,V>`	`sync()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.lettuce.core.api.StatefulRedisConnection
isMulti

Methods inherited from interface io.lettuce.core.api.StatefulConnection
close, closeAsync, dispatch, flushCommands, getResources, getTimeout, isOpen, reset, setAutoFlushCommands, setTimeout, setTimeout

- Constructor Detail
  - LettuceRedisPubSubConnection
```
public LettuceRedisPubSubConnection(org.apache.commons.pool2.impl.GenericObjectPool<StatefulRedisPubSubConnection<K,V>> connectionPool,
                                    RedisDatabase config)
                             throws Exception
```
    Throws:
    
    Exception
  - LettuceRedisPubSubConnection
```
public LettuceRedisPubSubConnection(StatefulRedisConnection<K,V> connection,
                                    RedisDatabase config)
```
- Method Detail
  - create
```
static <K,V> LettuceRedisPubSubConnection<K,V> create(StatefulRedisPubSubConnection<K,V> connection,
                                                      RedisDatabase config)
```
  - create
```
static <K,V> LettuceRedisPubSubConnection<K,V> create(org.apache.commons.pool2.impl.GenericObjectPool<StatefulRedisPubSubConnection<K,V>> connectionPool,
                                                      RedisDatabase config)
                                               throws Exception
```
    Throws:
    
    Exception
  - sync
```
public RedisPubSubCommands<K,V> sync()
```
    Specified by:
    
    sync in interface StatefulRedisConnection<K,V>
    
    Specified by:
    
    sync in interface StatefulRedisPubSubConnection<K,V>
  - async
```
public RedisPubSubAsyncCommands<K,V> async()
```
    Specified by:
    
    async in interface StatefulRedisConnection<K,V>
    
    Specified by:
    
    async in interface StatefulRedisPubSubConnection<K,V>
  - reactive
```
public RedisPubSubReactiveCommands<K,V> reactive()
```
    Specified by:
    
    reactive in interface StatefulRedisConnection<K,V>
    
    Specified by:
    
    reactive in interface StatefulRedisPubSubConnection<K,V>
  - addListener
```
public void addListener(RedisPubSubListener<K,V> listener)
```
    Specified by:
    
    addListener in interface StatefulRedisPubSubConnection<K,V>
  - removeListener
```
public void removeListener(RedisPubSubListener<K,V> listener)
```
    Specified by:
    
    removeListener in interface StatefulRedisPubSubConnection<K,V>
  - dispatch
```
public Collection<RedisCommand<K,V,?>> dispatch(Collection<? extends RedisCommand<K,V,?>> collection)
```
    Specified by:
    
    dispatch in interface StatefulConnection<K,V>
  - getOptions
```
public ClientOptions getOptions()
```
    Specified by:
    
    getOptions in interface StatefulConnection<K,V>
  - isValid
```
public boolean isValid(long timeOut,
                       TimeUnit unit)
```
    Pings the Redis server provided by RedisDatabase.uri()
    Creates a new RedisClient based on the RedisDatabase.uri() and sends a BaseRedisCommands.ping() command to verify that the server is reachable
    
    Specified by:
    
    isValid in interface Connection
    
    Parameters:
    
    timeOut - The time to wait for the database operation used to validate the connection to complete.
    
    unit - time unit of timeOut
    
    Returns:
    
    true if this connection is still valid
  - close
```
public void close()
           throws DatabaseException
```
    Specified by:
    
    close in interface StatefulConnection<K,V>
    
    Specified by:
    
    close in interface Connection
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    DatabaseException
  - isMulti
```
public boolean isMulti()
```
    Specified by:
    
    isMulti in interface StatefulRedisConnection<K,V>
  - setTimeout
```
public void setTimeout(Duration timeout)
```
    Specified by:
    
    setTimeout in interface StatefulConnection<K,V>
  - setTimeout
```
public void setTimeout(long timeout,
                       TimeUnit unit)
```
    Specified by:
    
    setTimeout in interface StatefulConnection<K,V>
  - getTimeout
```
public Duration getTimeout()
```
    Specified by:
    
    getTimeout in interface StatefulConnection<K,V>
  - dispatch
```
public <T> RedisCommand<K,V,T> dispatch(RedisCommand<K,V,T> command)
```
    Specified by:
    
    dispatch in interface StatefulConnection<K,V>
  - closeAsync
```
public CompletableFuture<Void> closeAsync()
```
    Specified by:
    
    closeAsync in interface StatefulConnection<K,V>
    
    Specified by:
    
    closeAsync in interface AsyncCloseable
  - isOpen
```
public boolean isOpen()
```
    Specified by:
    
    isOpen in interface StatefulConnection<K,V>
  - getResources
```
public ClientResources getResources()
```
    Specified by:
    
    getResources in interface StatefulConnection<K,V>
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface StatefulConnection<K,V>
  - setAutoFlushCommands
```
public void setAutoFlushCommands(boolean autoFlush)
```
    Specified by:
    
    setAutoFlushCommands in interface StatefulConnection<K,V>
  - flushCommands
```
public void flushCommands()
```
    Specified by:
    
    flushCommands in interface StatefulConnection<K,V>
  - getDelegate
```
public C getDelegate()
```

Class LettuceRedisPubSubConnection<K,V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.lettuce.core.api.StatefulRedisConnection

Methods inherited from interface io.lettuce.core.api.StatefulConnection

Constructor Detail

LettuceRedisPubSubConnection

LettuceRedisPubSubConnection

Method Detail

create

create

sync

async

reactive

addListener

removeListener

dispatch

getOptions

isValid

close

isMulti

setTimeout

setTimeout

getTimeout

dispatch

closeAsync

isOpen

getResources

reset

setAutoFlushCommands

flushCommands

getDelegate