Interface StreamChannel

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

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

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

  • Method Details

    • getDelegate

      StreamChannel getDelegate()
      Specified by:
      getDelegate in interface ReadStream<Buffer>
      Specified by:
      getDelegate in interface io.vertx.lang.rx.RxDelegate
      Specified by:
      getDelegate in interface StreamBase
      Specified by:
      getDelegate in interface WriteStream<Buffer>

    • pipe

      Pipe<Buffer> 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<Buffer>
      Returns:
      a pipe

    • pipeTo

      Completable pipeTo(WriteStream<Buffer> 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<Buffer>
      Parameters:
      dst - the destination write stream
      Returns:
      a future notified when the write stream will be ended with the outcome

    • rxPipeTo

      Completable rxPipeTo(WriteStream<Buffer> 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<Buffer>
      Parameters:
      dst - the destination write stream
      Returns:
      a future notified when the write stream will be ended with the outcome

    • write

      Completable write(Buffer data)
      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 .

      When the data is moved from the queue to the actual medium, the returned 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<Buffer>
      Parameters:
      data - the data to write
      Returns:
      a future completed with the write result

    • rxWrite

      Completable rxWrite(Buffer data)
      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 .

      When the data is moved from the queue to the actual medium, the returned 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:
      rxWrite in interface WriteStream<Buffer>
      Parameters:
      data - the data to write
      Returns:
      a future completed with the write result

    • end

      Completable end(Buffer data)
      Same as end(Buffer) but writes some data to the stream before ending.
      Specified by:
      end in interface WriteStream<Buffer>
      Parameters:
      data - the data to write
      Returns:
      a future completed with the result

    • rxEnd

      Completable rxEnd(Buffer data)
      Same as end(Buffer) but writes some data to the stream before ending.
      Specified by:
      rxEnd in interface WriteStream<Buffer>
      Parameters:
      data - the data to write
      Returns:
      a future completed with the result

    • 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<Buffer>
      Returns:
      true if write queue is full

    • exceptionHandler

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

    • handler

      StreamChannel handler(Handler<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<Buffer>
      Parameters:
      handler -
      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<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<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<Buffer>
      Parameters:
      amount -
      Returns:
      a reference to this, so the API can be used fluently

    • endHandler

      StreamChannel endHandler(Handler<Void> endHandler)

      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<Buffer>
      Parameters:
      endHandler -
      Returns:

    • 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<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(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<Buffer>
      Parameters:
      handler - the handler
      Returns:
      a reference to this, so the API can be used fluently

    • write

      Completable write(String str)
      Write a String to the connection, encoded in UTF-8.
      Parameters:
      str - the string to write
      Returns:
      a future result of the write

    • rxWrite

      Completable rxWrite(String str)
      Write a String to the connection, encoded in UTF-8.
      Parameters:
      str - the string to write
      Returns:
      a future result of the write

    • write

      Completable write(String str, String enc)
      Write a String to the connection, encoded using the encoding enc.
      Parameters:
      str - the string to write
      enc - the encoding to use
      Returns:
      a future completed with the result

    • rxWrite

      Completable rxWrite(String str, String enc)
      Write a String to the connection, encoded using the encoding enc.
      Parameters:
      str - the string to write
      enc - the encoding to use
      Returns:
      a future completed with the result

    • sendFile

      Completable 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.
      Parameters:
      filename - file name of the file to send
      Returns:
      a future result of the send operation

    • rxSendFile

      Completable rxSendFile(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.
      Parameters:
      filename - file name of the file to send
      Returns:
      a future result of the send operation

    • sendFile

      Completable 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.
      Parameters:
      filename - file name of the file to send
      offset - offset
      Returns:
      a future result of the send operation

    • rxSendFile

      Completable rxSendFile(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.
      Parameters:
      filename - file name of the file to send
      offset - offset
      Returns:
      a future result of the send operation

    • sendFile

      Completable 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.
      Parameters:
      filename - file name of the file to send
      offset - offset
      length - length
      Returns:
      a future result of the send operation

    • rxSendFile

      Completable rxSendFile(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.
      Parameters:
      filename - file name of the file to send
      offset - offset
      length - length
      Returns:
      a future result of the send operation

    • end

      Completable end()
      Calls close()
      Specified by:
      end in interface WriteStream<Buffer>
      Returns:
      a future completed with the result

    • rxEnd

      Completable rxEnd()
      Calls close()
      Specified by:
      rxEnd in interface WriteStream<Buffer>
      Returns:
      a future completed with the result

    • close

      Completable close()
      Close the channel
      Returns:
      a future completed with the result

    • rxClose

      Completable rxClose()
      Close the channel
      Returns:
      a future completed with the result

    • closeHandler

      StreamChannel closeHandler(Handler<Void> handler)
      Set a handler notified when the channel is closed
      Parameters:
      handler - the handler
      Returns:
      a reference to this, so the API can be used fluently

    • newInstance

      static StreamChannel newInstance(StreamChannel arg)