Interface StreamChannel

All Superinterfaces:
ReadStream<Buffer>, StreamBase, WriteStream<Buffer>
All Known Subinterfaces:
NetSocket, QuicStream
public interface StreamChannel extends ReadStream<Buffer>, WriteStream<Buffer>
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.

Author:
Julien Viet

  • Method Details

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

    • endHandler

      StreamChannel endHandler(Handler<Void> 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<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<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

      Future<Void> 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

    • write

      Future<Void> 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

    • sendFile

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

    • sendFile

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

    • sendFile

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

    • end

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

    • close

      Future<Void> close()
      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

    • shutdownHandler

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