Package io.vertx.reactivex.redis.client
Class RedisConnection
- java.lang.Object
-
- io.vertx.reactivex.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 theoriginal
non RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static 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 RedisConnection
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.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.RedisConnection
close()
Closes the connection or returns to the pool.RedisConnection
close(Handler<AsyncResult<Void>> onClose)
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 specifiedamount
of elements.RedisConnection
getDelegate()
RedisConnection
handler(Handler<Response> handler)
Set a data handler.int
hashCode()
static RedisConnection
newInstance(RedisConnection arg)
RedisConnection
pause()
Pause theReadStream
, it sets the buffer infetch
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)
Pipe thisReadStream
to theWriteStream
.void
pipeTo(WriteStream<Response> dst, Handler<AsyncResult<Void>> handler)
Pipe thisReadStream
to theWriteStream
.RedisConnection
resume()
Resume reading, and sets the buffer inflowing
mode.io.reactivex.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.io.reactivex.Completable
rxClose()
Closes the connection or returns to the pool.io.reactivex.Completable
rxPipeTo(WriteStream<Response> dst)
Pipe thisReadStream
to theWriteStream
.io.reactivex.Maybe<Response>
rxSend(Request command)
Send the given command to the redis server or cluster.RedisConnection
send(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.io.reactivex.Flowable<Response>
toFlowable()
io.reactivex.Observable<Response>
toObservable()
String
toString()
-
-
-
Field Detail
-
__TYPE_ARG
public static final TypeArg<RedisConnection> __TYPE_ARG
-
-
Constructor Detail
-
RedisConnection
public RedisConnection(RedisConnection delegate)
-
RedisConnection
public RedisConnection(Object delegate)
-
-
Method Detail
-
getDelegate
public RedisConnection getDelegate()
- Specified by:
getDelegate
in interfaceReadStream<Response>
- Specified by:
getDelegate
in interfaceStreamBase
-
toObservable
public io.reactivex.Observable<Response> toObservable()
- Specified by:
toObservable
in interfaceReadStream<Response>
-
toFlowable
public io.reactivex.Flowable<Response> toFlowable()
- Specified by:
toFlowable
in 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:
pipe
in interfaceReadStream<Response>
- Returns:
- a pipe
-
pipeTo
public void pipeTo(WriteStream<Response> dst, Handler<AsyncResult<Void>> handler)
Pipe thisReadStream
to theWriteStream
.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 interfaceReadStream<Response>
- Parameters:
dst
- the destination write streamhandler
-
-
pipeTo
public void pipeTo(WriteStream<Response> dst)
Pipe thisReadStream
to theWriteStream
.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 interfaceReadStream<Response>
- Parameters:
dst
- the destination write stream
-
rxPipeTo
public io.reactivex.Completable rxPipeTo(WriteStream<Response> dst)
Pipe thisReadStream
to theWriteStream
.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:
rxPipeTo
in interfaceReadStream<Response>
- 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 interfaceReadStream<Response>
- Specified by:
exceptionHandler
in interfaceStreamBase
- 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 interfaceReadStream<Response>
- Parameters:
handler
-- Returns:
-
pause
public RedisConnection pause()
Description copied from interface:ReadStream
Pause theReadStream
, it sets the buffer infetch
mode and clears the actual demand.While it's paused, no data will be sent to the data
handler
.- Specified by:
pause
in interfaceReadStream<Response>
- Returns:
-
resume
public RedisConnection resume()
Description copied from interface:ReadStream
Resume reading, and sets the buffer inflowing
mode. If theReadStream
has been paused, reading will recommence on it.- Specified by:
resume
in interfaceReadStream<Response>
- Returns:
-
fetch
public RedisConnection fetch(long amount)
Description copied from interface:ReadStream
Fetch the specifiedamount
of elements. If theReadStream
has been paused, reading will recommence with the specifiedamount
of items, otherwise the specifiedamount
will be added to the current stream demand.- Specified by:
fetch
in interfaceReadStream<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 interfaceReadStream<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 sendonSend
- the asynchronous result handler.- Returns:
- fluent self.
-
send
public RedisConnection send(Request command)
Send the given command to the redis server or cluster.- Parameters:
command
- the command to send- Returns:
- fluent self.
-
rxSend
public io.reactivex.Maybe<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 sendonSend
- the asynchronous result handler.- Returns:
- fluent self.
-
batch
public RedisConnection 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:
- fluent self.
-
rxBatch
public io.reactivex.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 RedisConnection close(Handler<AsyncResult<Void>> onClose)
Closes the connection or returns to the pool.- Parameters:
onClose
-- Returns:
-
close
public RedisConnection close()
Closes the connection or returns to the pool.- Returns:
-
rxClose
public io.reactivex.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)
-
-