Package io.vertx.ext.reactivestreams

Interface ReactiveWriteStream<T>

  • All Superinterfaces:
    org.reactivestreams.Publisher<T>, StreamBase, WriteStream<T>
    public interface ReactiveWriteStream<T>
extends WriteStream<T>, org.reactivestreams.Publisher<T>
    A Vert.x write stream that also implements reactive streams publisher interface.
    Author:
    Tim Fox

    • Field Detail

      • DEFAULT_WRITE_QUEUE_MAX_SIZE

        static final int DEFAULT_WRITE_QUEUE_MAX_SIZE
        Default write queue max size
        See Also:
        Constant Field Values

    • Method Detail

      • writeStream

        static <T> ReactiveWriteStream<T> writeStream​(Vertx vertx)
        Create a reactive write stream
        Parameters:
        vertx - the Vert.x instance
        Returns:
        the stream

      • write

        Future<Void> write​(T data)
        Description copied from interface: WriteStream
        Write some data to the stream.

        The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the WriteStream.writeQueueFull() method before writing. This is done automatically if using a Pipe.

        When the data is moved from the queue to the actual medium, the returned Future will be completed with the write result, e.g the future is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.

        Specified by:
        write in interface WriteStream<T>
        Parameters:
        data - the data to write
        Returns:
        a future completed with the write result

      • setWriteQueueMaxSize

        ReactiveWriteStream<T> setWriteQueueMaxSize​(int maxSize)
        Description copied from interface: WriteStream
        Set the maximum size of the write queue to maxSize. You will still be able to write to the stream even if there is more than maxSize items in the write queue. This is used as an indicator by classes such as Pipe to provide flow control.

        The value is defined by the implementation of the stream, e.g in bytes for a NetSocket, etc...

        Specified by:
        setWriteQueueMaxSize in interface WriteStream<T>
        Parameters:
        maxSize - the max size of the write stream
        Returns:
        a reference to this, so the API can be used fluently

      • drainHandler

        ReactiveWriteStream<T> drainHandler​(Handler<Void> handler)
        Description copied from interface: WriteStream
        Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue is ready to accept buffers again. See Pipe for an example of this being used.

        The stream implementation defines when the drain handler, for example it could be when the queue size has been reduced to maxSize / 2.

        Specified by:
        drainHandler in interface WriteStream<T>
        Parameters:
        handler - the handler
        Returns:
        a reference to this, so the API can be used fluently

      • close

        ReactiveWriteStream<T> close()
        Close the stream
        Returns:
        a reference to this for a fluent API