Package io.vertx.reactivex.redis.client

Class 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 original non RX-ified interface using Vert.x codegen.

    • Field Detail

      • __TYPE_ARG

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

    • Constructor Detail

      • RedisConnection

        public RedisConnection​(Object delegate)

    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • 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 Future<Void> pipeTo​(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.

        Specified by:
        pipeTo in interface ReadStream<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 this ReadStream to the WriteStream.

        Elements emitted by this stream will be written to the write stream until this stream ends or fails.

        Specified by:
        rxPipeTo in interface ReadStream<Response>
        Parameters:
        dst - the destination write stream
        Returns:
        a future notified when the write stream will be ended with the outcome

      • 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 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

      • close

        public Future<Void> close()
        Closes the connection or returns to the pool.
        Returns:

      • 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.