Package io.vertx.reactivex.redis.client
Class RedisConnection
- java.lang.Object
-
- io.vertx.reactivex.redis.client.RedisConnection
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate,ReadStream<Response>,StreamBase
public class RedisConnection extends Object implements io.vertx.lang.rx.RxDelegate, ReadStream<Response>
A simple Redis client.NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<RedisConnection>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description RedisConnection(RedisConnection delegate)RedisConnection(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Future<List<Response>>batch(List<Request> commands)Sends a list of commands in a single IO operation, this prevents any inter twinning to happen from other client users.Future<Void>close()Closes the connection or returns to the pool.RedisConnectionendHandler(Handler<Void> endHandler)Set an end handler.booleanequals(Object o)RedisConnectionexceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.RedisConnectionfetch(long amount)Fetch the specifiedamountof elements.RedisConnectiongetDelegate()RedisConnectionhandler(Handler<Response> handler)Set a data handler.inthashCode()static RedisConnectionnewInstance(RedisConnection arg)RedisConnectionpause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.booleanpendingQueueFull()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 .Future<Void>pipeTo(WriteStream<Response> dst)Pipe thisReadStreamto theWriteStream.RedisConnectionresume()Resume reading, and sets the buffer inflowingmode.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.CompletablerxClose()Closes the connection or returns to the pool.CompletablerxPipeTo(WriteStream<Response> dst)Pipe thisReadStreamto theWriteStream.Maybe<Response>rxSend(Request command)Send the given command to the redis server or cluster.Future<Response>send(Request command)Send the given command to the redis server or cluster.Flowable<Response>toFlowable()Observable<Response>toObservable()StringtoString()
-
-
-
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
-
getDelegate
public RedisConnection getDelegate()
- Specified by:
getDelegatein interfaceReadStream<Response>- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate- Specified by:
getDelegatein interfaceStreamBase
-
toObservable
public Observable<Response> toObservable()
- Specified by:
toObservablein interfaceReadStream<Response>
-
toFlowable
public Flowable<Response> toFlowable()
- Specified by:
toFlowablein interfaceReadStream<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 aWriteStream.- Specified by:
pipein interfaceReadStream<Response>- Returns:
- a pipe
-
pipeTo
public Future<Void> pipeTo(WriteStream<Response> dst)
Pipe thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
pipeToin interfaceReadStream<Response>- Parameters:
dst- the destination write stream- Returns:
- a future notified when the write stream will be ended with the outcome
-
rxPipeTo
public Completable rxPipeTo(WriteStream<Response> dst)
Pipe thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
rxPipeToin interfaceReadStream<Response>- Parameters:
dst- the destination write stream- Returns:
- a future notified when the write stream will be ended with the outcome
-
exceptionHandler
public RedisConnection exceptionHandler(Handler<Throwable> handler)
Description copied from interface:ReadStreamSet an exception handler on the read stream.- Specified by:
exceptionHandlerin interfaceReadStream<Response>- Specified by:
exceptionHandlerin interfaceStreamBase- Parameters:
handler-- Returns:
-
handler
public RedisConnection handler(Handler<Response> handler)
Description copied from interface:ReadStreamSet a data handler. As data is read, the handler will be called with the data.- Specified by:
handlerin interfaceReadStream<Response>- Parameters:
handler-- Returns:
-
pause
public RedisConnection pause()
Description copied from interface:ReadStreamPause theReadStream, it sets the buffer infetchmode and clears the actual demand.While it's paused, no data will be sent to the data
handler.- Specified by:
pausein interfaceReadStream<Response>- Returns:
-
resume
public RedisConnection resume()
Description copied from interface:ReadStreamResume reading, and sets the buffer inflowingmode. If theReadStreamhas been paused, reading will recommence on it.- Specified by:
resumein interfaceReadStream<Response>- Returns:
-
fetch
public RedisConnection fetch(long amount)
Description copied from interface:ReadStreamFetch the specifiedamountof elements. If theReadStreamhas been paused, reading will recommence with the specifiedamountof items, otherwise the specifiedamountwill be added to the current stream demand.- Specified by:
fetchin interfaceReadStream<Response>- Parameters:
amount-- Returns:
-
endHandler
public RedisConnection endHandler(Handler<Void> endHandler)
Description copied from interface:ReadStreamSet an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.- Specified by:
endHandlerin interfaceReadStream<Response>- Parameters:
endHandler-- Returns:
-
send
public Future<Response> send(Request command)
Send the given command to the redis server or cluster.- Parameters:
command- the command to send- Returns:
- a future with the result of the operation
-
rxSend
public Maybe<Response> rxSend(Request command)
Send the given command to the redis server or cluster.- Parameters:
command- the command to send- Returns:
- a future with the result of the operation
-
batch
public Future<List<Response>> batch(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:
- a future with the result of the operation
-
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:
- a future with the result of the operation
-
rxClose
public Completable rxClose()
Closes the connection or returns to the pool.- Returns:
-
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)
-
-