RedisConnection (Vert.x Stack

java.lang.Object
- io.vertx.rxjava.redis.client.RedisConnection

All Implemented Interfaces:

ReadStream<Response>, StreamBase
```
public class RedisConnection
extends Object
implements ReadStream<Response>
```
A simple Redis client.
NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields
Modifier and Type Field and Description

static io.vertx.lang.rx.TypeArg<RedisConnection> __TYPE_ARG

Fields
Modifier and Type	Field and Description
`static io.vertx.lang.rx.TypeArg<RedisConnection>`	`__TYPE_ARG`

Constructor Summary

Constructors
Constructor and Description

RedisConnection(Object delegate)

RedisConnection(RedisConnection delegate)

Constructors
Constructor and Description
`RedisConnection(Object delegate)`
`RedisConnection(RedisConnection delegate)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`RedisConnection`	`batch(List<Request> commands, Handler<AsyncResult<List<Response>>> onSend)` Sends a list of commands in a single IO operation, this prevents any inter twinning to happen from other client users.
`Observable<List<Response>>`	`batchObservable(List<Request> commands)` Deprecated. use `rxBatch(java.util.List<io.vertx.rxjava.redis.client.Request>)` instead
`void`	`close()` Closes the connection or returns to the pool.
`RedisConnection`	`endHandler(Handler<Void> endHandler)` Set an end handler.
`boolean`	`equals(Object o)`
`RedisConnection`	`exceptionHandler(Handler<Throwable> handler)` Set an exception handler on the read stream.
`RedisConnection`	`fetch(long amount)` Fetch the specified `amount` of elements.
`RedisConnection`	`getDelegate()`
`RedisConnection`	`handler(Handler<Response> handler)` Set a data handler.
`int`	`hashCode()`
`static RedisConnection`	`newInstance(RedisConnection arg)`
`RedisConnection`	`pause()` Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.
`boolean`	`pendingQueueFull()` Flag to notify if the pending message queue (commands in transit) is full.
`Pipe<Response>`	`pipe()` Pause this stream and return a to transfer the elements of this stream to a destination .
`void`	`pipeTo(WriteStream<Response> dst)` Like `ReadStream.pipeTo(io.vertx.rxjava.core.streams.WriteStream<T>)` but with no completion handler.
`void`	`pipeTo(WriteStream<Response> dst, Handler<AsyncResult<Void>> handler)` Pipe this `ReadStream` to the `WriteStream`.
`Observable<Void>`	`pipeToObservable(WriteStream<Response> dst)` Deprecated. use `rxPipeTo(io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.redis.client.Response>)` instead
`RedisConnection`	`resume()` Resume reading, and sets the buffer in `flowing` mode.
`Single<List<Response>>`	`rxBatch(List<Request> commands)` Sends a list of commands in a single IO operation, this prevents any inter twinning to happen from other client users.
`Single<Void>`	`rxPipeTo(WriteStream<Response> dst)` Pipe this `ReadStream` to the `WriteStream`.
`Single<Response>`	`rxSend(Request command)` Send the given command to the redis server or cluster.
`RedisConnection`	`send(Request command, Handler<AsyncResult<Response>> onSend)` Send the given command to the redis server or cluster.
`Observable<Response>`	`sendObservable(Request command)` Deprecated. use `rxSend(io.vertx.rxjava.redis.client.Request)` instead
`Observable<Response>`	`toObservable()`
`String`	`toString()`

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

Methods inherited from interface io.vertx.rxjava.core.streams.ReadStream
newInstance, newInstance

Methods inherited from interface io.vertx.rxjava.core.streams.StreamBase
newInstance

- Field Detail
  - __TYPE_ARG
```
public static final io.vertx.lang.rx.TypeArg<RedisConnection> __TYPE_ARG
```
- Constructor Detail
  - RedisConnection
```
public RedisConnection(RedisConnection delegate)
```
  - RedisConnection
```
public RedisConnection(Object delegate)
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getDelegate
```
public RedisConnection getDelegate()
```
    Specified by:
    
    getDelegate in interface ReadStream<Response>
    
    Specified by:
    
    getDelegate in interface StreamBase
  - toObservable
```
public Observable<Response> toObservable()
```
    Specified by:
    
    toObservable in interface ReadStream<Response>
  - pipe
```
public Pipe<Response> pipe()
```
    Pause this stream and return a to transfer the elements of this stream to a destination .
    The stream will be resumed when the pipe will be wired to a WriteStream.
    
    Specified by:
    
    pipe in interface ReadStream<Response>
    
    Returns:
    
    a pipe
  - pipeTo
```
public void pipeTo(WriteStream<Response> dst)
```
    Like ReadStream.pipeTo(io.vertx.rxjava.core.streams.WriteStream<T>) but with no completion handler.
    
    Specified by:
    
    pipeTo in interface ReadStream<Response>
    
    Parameters:
    
    dst -
  - pipeTo
```
public void pipeTo(WriteStream<Response> dst,
                   Handler<AsyncResult<Void>> handler)
```
    Pipe this ReadStream to the WriteStream.
    Elements emitted by this stream will be written to the write stream until this stream ends or fails.
    Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.
    
    Specified by:
    
    pipeTo in interface ReadStream<Response>
    
    Parameters:
    
    dst - the destination write stream
    
    handler -
  - pipeToObservable
```
@Deprecated
public Observable<Void> pipeToObservable(WriteStream<Response> dst)
```
    Deprecated. use rxPipeTo(io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.redis.client.Response>) instead
    
    Pipe this ReadStream to the WriteStream.
    Elements emitted by this stream will be written to the write stream until this stream ends or fails.
    Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.
    
    Parameters:
    
    dst - the destination write stream
    
    Returns:
  - rxPipeTo
```
public Single<Void> rxPipeTo(WriteStream<Response> dst)
```
    Pipe this ReadStream to the WriteStream.
    Elements emitted by this stream will be written to the write stream until this stream ends or fails.
    Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.
    
    Parameters:
    
    dst - the destination write stream
    
    Returns:
  - exceptionHandler
```
public RedisConnection exceptionHandler(Handler<Throwable> handler)
```
    Description copied from interface: ReadStream
    
    Set an exception handler on the read stream.
    
    Specified by:
    
    exceptionHandler in interface ReadStream<Response>
    
    Specified by:
    
    exceptionHandler in interface StreamBase
    
    Parameters:
    
    handler -
    
    Returns:
  - handler
```
public RedisConnection handler(Handler<Response> handler)
```
    Description copied from interface: ReadStream
    
    Set a data handler. As data is read, the handler will be called with the data.
    
    Specified by:
    
    handler in interface ReadStream<Response>
    
    Parameters:
    
    handler -
    
    Returns:
  - pause
```
public RedisConnection pause()
```
    Description copied from interface: ReadStream
    
    Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.
    While it's paused, no data will be sent to the data handler.
    
    Specified by:
    
    pause in interface ReadStream<Response>
    
    Returns:
  - resume
```
public RedisConnection resume()
```
    Description copied from interface: ReadStream
    
    Resume reading, and sets the buffer in flowing mode.
    If the ReadStream has been paused, reading will recommence on it.
    
    Specified by:
    
    resume in interface ReadStream<Response>
    
    Returns:
  - fetch
```
public RedisConnection fetch(long amount)
```
    Description copied from interface: ReadStream
    
    Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand.
    
    Specified by:
    
    fetch in interface ReadStream<Response>
    
    Parameters:
    
    amount -
    
    Returns:
  - endHandler
```
public RedisConnection endHandler(Handler<Void> endHandler)
```
    Description copied from interface: ReadStream
    
    Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.
    
    Specified by:
    
    endHandler in interface ReadStream<Response>
    
    Parameters:
    
    endHandler -
    
    Returns:
  - send
```
public RedisConnection send(Request command,
                            Handler<AsyncResult<Response>> onSend)
```
    Send the given command to the redis server or cluster.
    
    Parameters:
    
    command - the command to send
    
    onSend - the asynchronous result handler.
    
    Returns:
    
    fluent self.
  - sendObservable
```
@Deprecated
public Observable<Response> sendObservable(Request command)
```
    Deprecated. use rxSend(io.vertx.rxjava.redis.client.Request) instead
    
    Send the given command to the redis server or cluster.
    
    Parameters:
    
    command - the command to send
    
    Returns:
    
    fluent self.
  - rxSend
```
public Single<Response> rxSend(Request command)
```
    Send the given command to the redis server or cluster.
    
    Parameters:
    
    command - the command to send
    
    Returns:
    
    fluent self.
  - batch
```
public RedisConnection batch(List<Request> commands,
                             Handler<AsyncResult<List<Response>>> onSend)
```
    Sends a list of commands in a single IO operation, this prevents any inter twinning to happen from other client users.
    
    Parameters:
    
    commands - list of command to send
    
    onSend - the asynchronous result handler.
    
    Returns:
    
    fluent self.
  - batchObservable
```
@Deprecated
public Observable<List<Response>> batchObservable(List<Request> commands)
```
    Deprecated. use rxBatch(java.util.List<io.vertx.rxjava.redis.client.Request>) instead
    
    Sends a list of commands in a single IO operation, this prevents any inter twinning to happen from other client users.
    
    Parameters:
    
    commands - list of command to send
    
    Returns:
    
    fluent self.
  - rxBatch
```
public Single<List<Response>> rxBatch(List<Request> commands)
```
    Sends a list of commands in a single IO operation, this prevents any inter twinning to happen from other client users.
    
    Parameters:
    
    commands - list of command to send
    
    Returns:
    
    fluent self.
  - close
```
public void close()
```
    Closes the connection or returns to the pool.
  - pendingQueueFull
```
public boolean pendingQueueFull()
```
    Flag to notify if the pending message queue (commands in transit) is full. When the pending message queue is full and a new send command is issued it will result in a exception to be thrown. Checking this flag before sending can allow the application to wait before sending the next message.
    
    Returns:
    
    true is queue is full.
  - newInstance
```
public static RedisConnection newInstance(RedisConnection arg)
```

Class RedisConnection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.vertx.rxjava.core.streams.ReadStream

Methods inherited from interface io.vertx.rxjava.core.streams.StreamBase

Field Detail

__TYPE_ARG

Constructor Detail

RedisConnection

RedisConnection

Method Detail

toString

equals

hashCode

getDelegate

toObservable

pipe

pipeTo

pipeTo

pipeToObservable

rxPipeTo

exceptionHandler

handler

pause

resume

fetch

endHandler

send

sendObservable

rxSend

batch

batchObservable

rxBatch

close

pendingQueueFull

newInstance