Package io.vertx.reactivex.core

Class TimeoutStream

  • All Implemented Interfaces:
    ReadStream<Long>, StreamBase
    public class TimeoutStream
extends Object
implements ReadStream<Long>
    A timeout stream is triggered by a timer, the Handler will be call when the timer is fired, it can be once or several times depending on the nature of the timer related to this stream. The will be called after the timer handler has been called.

    Pausing the timer inhibits the timer shots until the stream is resumed. Setting a null handler callback cancels the timer.

    NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

    • Constructor Detail

      • TimeoutStream

        public TimeoutStream​(TimeoutStream delegate)

      • TimeoutStream

        public TimeoutStream​(Object delegate)

    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • pipe

        @Deprecated
public Pipe<Long> pipe()
        Deprecated.
        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<Long>
        Returns:
        a pipe

      • pipeTo

        @Deprecated
public void pipeTo​(WriteStream<Long> dst,
                   Handler<AsyncResult<Void>> handler)
        Deprecated.
        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<Long>
        Parameters:
        dst - the destination write stream
        handler -

      • pipeTo

        @Deprecated
public void pipeTo​(WriteStream<Long> dst)
        Deprecated.
        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<Long>
        Parameters:
        dst - the destination write stream

      • rxPipeTo

        @Deprecated
public io.reactivex.Completable rxPipeTo​(WriteStream<Long> dst)
        Deprecated.
        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:
        rxPipeTo in interface ReadStream<Long>
        Parameters:
        dst - the destination write stream
        Returns:

      • handler

        @Deprecated
public TimeoutStream handler​(Handler<Long> handler)
        Deprecated.
        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<Long>
        Returns:
        a reference to this, so the API can be used fluently

      • pause

        @Deprecated
public TimeoutStream pause()
        Deprecated.
        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<Long>
        Returns:
        a reference to this, so the API can be used fluently

      • resume

        @Deprecated
public TimeoutStream resume()
        Deprecated.
        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<Long>
        Returns:
        a reference to this, so the API can be used fluently

      • fetch

        @Deprecated
public TimeoutStream fetch​(long amount)
        Deprecated.
        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<Long>
        Returns:
        a reference to this, so the API can be used fluently

      • endHandler

        @Deprecated
public TimeoutStream endHandler​(Handler<Void> endHandler)
        Deprecated.
        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<Long>
        Returns:
        a reference to this, so the API can be used fluently