Package io.vertx.mutiny.core.net

Interface StreamChannel

All Superinterfaces:
MutinyDelegate, ReadStream<io.vertx.core.buffer.Buffer>, StreamBase, WriteStream<io.vertx.core.buffer.Buffer>
All Known Implementing Classes:
NetSocket, QuicStream, StreamChannel.StreamChannelImpl
public interface StreamChannel extends ReadStream<io.vertx.core.buffer.Buffer>, WriteStream<io.vertx.core.buffer.Buffer>, MutinyDelegate
Represents a channel interface modelling a duplex flow controlled byte oriented stream.

It implements both ReadStream and WriteStream so it can be used with Pipe to pipe data with flow control.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:
Julien Viet
See Also:
  • StreamChannel

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    StreamChannel.StreamChannelImpl
     

    Nested classes/interfaces inherited from interface io.vertx.mutiny.core.streams.ReadStream

    ReadStream.ReadStreamImpl<T>

    Nested classes/interfaces inherited from interface io.vertx.mutiny.core.streams.StreamBase

    StreamBase.StreamBaseImpl

    Nested classes/interfaces inherited from interface io.vertx.mutiny.core.streams.WriteStream

    WriteStream.WriteStreamImpl<T>

  • Method Summary

    Modifier and Type
    Method
    Description
    io.smallrye.mutiny.Uni<Void>
    close()
    Close the channel
    StreamChannel
    closeHandler(Runnable handler)
    Set a handler notified when the channel is closed
    StreamChannel
    drainHandler(Runnable handler)
    Set a drain handler on the stream.
    io.smallrye.mutiny.Uni<Void>
    end()
    Calls close()
    io.smallrye.mutiny.Uni<Void>
    end(io.vertx.core.buffer.Buffer arg0)
    Same as end() but writes some data to the stream before ending.
    StreamChannel
    endHandler(Runnable endHandler)
    Set an end handler.
    StreamChannel
    exceptionHandler(Consumer<Throwable> handler)
    Set an exception handler on the read stream.
    StreamChannel
    fetch(long amount)
    Fetch the specified amount of elements.
    io.vertx.core.net.StreamChannel
    getDelegate()
     
    StreamChannel
    handler(Consumer<io.vertx.core.buffer.Buffer> handler)
    Set a data handler.
    static StreamChannel
    newInstance(io.vertx.core.net.StreamChannel delegate)
    Creates a new instance of the StreamChannel.
    StreamChannel
    pause()
    Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.
    Pipe<io.vertx.core.buffer.Buffer>
    pipe()
    Pause this stream and return a Pipe to transfer the elements of this stream to a destination WriteStream.
    io.smallrye.mutiny.Uni<Void>
    pipeTo(WriteStream<io.vertx.core.buffer.Buffer> arg0)
    Pipe this ReadStream to the WriteStream.
    StreamChannel
    resume()
    Resume reading, and sets the buffer in flowing mode.
    io.smallrye.mutiny.Uni<Void>
    sendFile(String filename)
    Tell the operating system to stream a file as specified by filename directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system.
    io.smallrye.mutiny.Uni<Void>
    sendFile(String filename, long offset)
    Tell the operating system to stream a file as specified by filename directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system.
    io.smallrye.mutiny.Uni<Void>
    sendFile(String filename, long offset, long length)
    Tell the operating system to stream a file as specified by filename directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system.
    StreamChannel
    setWriteQueueMaxSize(int maxSize)
    Set the maximum size of the write queue to maxSize.
    StreamChannel
    shutdownHandler(Consumer<Duration> handler)
    Set a handler notified when the channel is shutdown: the client or server will close the connection within a certain amount of time.
    io.smallrye.mutiny.Multi<io.vertx.core.buffer.Buffer>
    toMulti()
     
    io.smallrye.mutiny.Uni<Void>
    write(io.vertx.core.buffer.Buffer arg0)
    Write some data to the stream.
    io.smallrye.mutiny.Uni<Void>
    write(String str)
    Write a String to the connection, encoded in UTF-8.
    io.smallrye.mutiny.Uni<Void>
    write(String str, String enc)
    Write a String to the connection, encoded using the encoding enc.
    boolean
    writeQueueFull()
    This will return true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int)

  • Method Details

    • getDelegate

      io.vertx.core.net.StreamChannel getDelegate()
      Specified by:
      getDelegate in interface MutinyDelegate
      Specified by:
      getDelegate in interface ReadStream<io.vertx.core.buffer.Buffer>
      Specified by:
      getDelegate in interface StreamBase
      Specified by:
      getDelegate in interface WriteStream<io.vertx.core.buffer.Buffer>
      Returns:
      the delegate used by this Mutiny object of generated type

    • write

      @CheckReturnValue io.smallrye.mutiny.Uni<Void> write(String str)
      Write a String to the connection, encoded in UTF-8.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      str - the string to write
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • StreamChannel.write(String)

    • write

      @CheckReturnValue io.smallrye.mutiny.Uni<Void> write(String str, String enc)
      Write a String to the connection, encoded using the encoding enc.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      str - the string to write
      enc - the encoding to use
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • StreamChannel.write(String, String)

    • sendFile

      @CheckReturnValue io.smallrye.mutiny.Uni<Void> sendFile(String filename)
      Tell the operating system to stream a file as specified by filename directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      filename - file name of the file to send
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • StreamChannel.sendFile(String)

    • sendFile

      @CheckReturnValue io.smallrye.mutiny.Uni<Void> sendFile(String filename, long offset)
      Tell the operating system to stream a file as specified by filename directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      filename - file name of the file to send
      offset - offset
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • StreamChannel.sendFile(String, long)

    • sendFile

      @CheckReturnValue io.smallrye.mutiny.Uni<Void> sendFile(String filename, long offset, long length)
      Tell the operating system to stream a file as specified by filename directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      filename - file name of the file to send
      offset - offset
      length - length
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • StreamChannel.sendFile(String, long, long)

    • end

      @CheckReturnValue io.smallrye.mutiny.Uni<Void> end()
      Calls close()

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Specified by:
      end in interface WriteStream<io.vertx.core.buffer.Buffer>
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • StreamChannel.end()

    • close

      @CheckReturnValue io.smallrye.mutiny.Uni<Void> close()
      Close the channel

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • StreamChannel.close()

    • end

      @CheckReturnValue io.smallrye.mutiny.Uni<Void> end(io.vertx.core.buffer.Buffer arg0)
      Same as end() but writes some data to the stream before ending.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Specified by:
      end in interface WriteStream<io.vertx.core.buffer.Buffer>
      Parameters:
      data - the data to write
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • WriteStream.end(T)

    • pipeTo

      @CheckReturnValue io.smallrye.mutiny.Uni<Void> pipeTo(WriteStream<io.vertx.core.buffer.Buffer> arg0)
      Pipe this ReadStream to the WriteStream.

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

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Specified by:
      pipeTo in interface ReadStream<io.vertx.core.buffer.Buffer>
      Parameters:
      dst - the destination write stream
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.core.net.StreamChannel#pipeTo(WriteStream)

    • write

      @CheckReturnValue io.smallrye.mutiny.Uni<Void> write(io.vertx.core.buffer.Buffer arg0)
      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 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 uni 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.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Specified by:
      write in interface WriteStream<io.vertx.core.buffer.Buffer>
      Parameters:
      data - the data to write
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • StreamChannel.write(T)

    • exceptionHandler

      StreamChannel exceptionHandler(Consumer<Throwable> handler)
      Description copied from interface: ReadStream
      Set an exception handler on the read stream.
      Specified by:
      exceptionHandler in interface ReadStream<io.vertx.core.buffer.Buffer>
      Specified by:
      exceptionHandler in interface StreamBase
      Specified by:
      exceptionHandler in interface WriteStream<io.vertx.core.buffer.Buffer>
      Parameters:
      handler - the exception handler. Can be null.
      Returns:
      a reference to this, so the API can be used fluently

    • handler

      StreamChannel handler(Consumer<io.vertx.core.buffer.Buffer> 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 interface ReadStream<io.vertx.core.buffer.Buffer>
      Returns:
      a reference to this, so the API can be used fluently

    • pause

      StreamChannel 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<io.vertx.core.buffer.Buffer>
      Returns:
      a reference to this, so the API can be used fluently

    • resume

      StreamChannel 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<io.vertx.core.buffer.Buffer>
      Returns:
      a reference to this, so the API can be used fluently

    • fetch

      StreamChannel 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<io.vertx.core.buffer.Buffer>
      Returns:
      a reference to this, so the API can be used fluently

    • endHandler

      StreamChannel endHandler(Runnable endHandler)
      Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.

      This handler might be called after the close handler when the channel is paused and there are still buffers to deliver.

      Specified by:
      endHandler in interface ReadStream<io.vertx.core.buffer.Buffer>
      Returns:
      a reference to this, so the API can be used fluently

    • setWriteQueueMaxSize

      StreamChannel 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<io.vertx.core.buffer.Buffer>
      Parameters:
      maxSize - the max size of the write stream
      Returns:
      a reference to this, so the API can be used fluently

    • drainHandler

      StreamChannel drainHandler(Runnable 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<io.vertx.core.buffer.Buffer>
      Parameters:
      handler - the handler. Can be null.
      Returns:
      a reference to this, so the API can be used fluently

    • closeHandler

      StreamChannel closeHandler(Runnable handler)
      Set a handler notified when the channel is closed
      Parameters:
      handler - the handler. Can be null.
      Returns:
      a reference to this, so the API can be used fluently

    • shutdownHandler

      StreamChannel shutdownHandler(Consumer<Duration> handler)
      Set a handler notified when the channel is shutdown: the client or server will close the connection within a certain amount of time. This gives the opportunity to the handler to close the channel gracefully before the channel is closed.
      Parameters:
      handler - the handler notified. Can be null.
      Returns:
      a reference to this, so the API can be used fluently

    • pipe

      Pipe<io.vertx.core.buffer.Buffer> pipe()
      Pause this stream and return a Pipe to transfer the elements of this stream to a destination WriteStream.

      The stream will be resumed when the pipe will be wired to a WriteStream.

      Specified by:
      pipe in interface ReadStream<io.vertx.core.buffer.Buffer>
      Returns:
      a pipe

    • writeQueueFull

      boolean writeQueueFull()
      This will return true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int)
      Specified by:
      writeQueueFull in interface WriteStream<io.vertx.core.buffer.Buffer>
      Returns:
      true if write queue is full

    • newInstance

      static StreamChannel newInstance(io.vertx.core.net.StreamChannel delegate)
      Creates a new instance of the StreamChannel.

    • toMulti

      io.smallrye.mutiny.Multi<io.vertx.core.buffer.Buffer> toMulti()