Package io.vertx.mutiny.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 Mutiny-ified interface using Vert.x codegen.

    • Constructor Detail

      • TimeoutStream

        public TimeoutStream​(io.vertx.core.TimeoutStream delegate)

      • TimeoutStream

        public TimeoutStream​(Object delegate)

    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • pipeTo

        public io.smallrye.mutiny.Uni<Void> pipeTo​(WriteStream<Long> 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.

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Specified by:
        pipeTo in interface ReadStream<Long>
        Parameters:
        dst - the destination write stream
        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.

      • pipeToAndAwait

        public Void pipeToAndAwait​(WriteStream<Long> dst)
        Blocking variant of io.vertx.mutiny.core.streams.ReadStream#pipeTo(io.vertx.mutiny.core.streams.WriteStream).

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Specified by:
        pipeToAndAwait in interface ReadStream<Long>
        Parameters:
        dst - the destination write stream
        Returns:
        the Void instance produced by the operation.

      • pipeToAndForget

        public void pipeToAndForget​(WriteStream<Long> dst)
        Variant of io.vertx.mutiny.core.streams.ReadStream#pipeTo(io.vertx.mutiny.core.streams.WriteStream) that ignores the result of the operation.

        This method subscribes on the result of io.vertx.mutiny.core.streams.ReadStream#pipeTo(io.vertx.mutiny.core.streams.WriteStream), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from io.vertx.mutiny.core.streams.ReadStream#pipeTo(io.vertx.mutiny.core.streams.WriteStream) but you don't need to compose it with other operations.

        Specified by:
        pipeToAndForget in interface ReadStream<Long>
        Parameters:
        dst - the destination write stream

      • fetch

        public TimeoutStream fetch​(long amount)
        Specified by:
        fetch in interface ReadStream<Long>
        Returns:
        a reference to this, so the API can be used fluently

      • cancel

        public void cancel()

      • toBlockingIterable

        public Iterable<Long> toBlockingIterable()

      • toBlockingStream

        public Stream<Long> toBlockingStream()

      • newInstance

        public static TimeoutStream newInstance​(io.vertx.core.TimeoutStream arg)