Interface QuicStream

All Superinterfaces:
ReadStream<Buffer>, StreamBase, StreamChannel, WriteStream<Buffer>
public interface QuicStream extends StreamChannel
A Quic stream.
Author:
Julien Viet

  • Method Details

    • id

      long id()

    • isBidirectional

      boolean isBidirectional()
      Returns:
      whether the stream is unidirectional or bidirectional

    • isLocalCreated

      boolean isLocalCreated()
      Returns:
      whether the stream was created by this connection

    • connection

      QuicConnection connection()
      Returns:
      the Quic connection this streams belongs to

    • resetHandler

      QuicStream resetHandler(Handler<Long> handler)

      Set a handler called upon stream reset: when a stream receives a reset frame from its peer, this handler is called.

      When no such handler is set, the stream exception handler is called and then the stream is automatically closed. Setting this handler changes this behavior: the handler processes the reset event and the handler has the full responsibility of managing the stream. That means the sending part of this stream is left untouched and the application can continue sending data.

      Parameters:
      handler - the handler
      Returns:
      this instance of a stream

    • reset

      Future<Void> reset(int error)
      Abruptly terminate the sending part of the stream with the specified application protocol error code argument, a RESET frame is sent to the remote peer.
      Parameters:
      error - the application protocol error code
      Returns:
      a future completed when the reset frame has been sent

    • abort

      Future<Void> abort(int error)
      Instruct the remote peer that this part of the stream is no longer interested in received data and wants it to cease transmission, a STOP_SENDING frame is sent to the remote peer.
      Parameters:
      error - the error code
      Returns:
      a future completed when the STOP_SENDING frame has been sent

    • closeHandler

      QuicStream closeHandler(Handler<Void> handler)
      Set a handler called when the stream is closed.
      Specified by:
      closeHandler in interface StreamChannel
      Parameters:
      handler - the handler signaled with the stream close
      Returns:
      this instance of a stream

    • shutdownHandler

      QuicStream shutdownHandler(Handler<Duration> handler)
      Set a handler called when the stream is shutdown or closed
      Specified by:
      shutdownHandler in interface StreamChannel
      Parameters:
      handler - the handler signaled with the stream shutdown
      Returns:
      this instance of a stream

    • exceptionHandler

      QuicStream exceptionHandler(Handler<Throwable> handler)
      Set an exception handling, catching stream exceptions.
      Specified by:
      exceptionHandler in interface ReadStream<Buffer>
      Specified by:
      exceptionHandler in interface StreamBase
      Specified by:
      exceptionHandler in interface StreamChannel
      Specified by:
      exceptionHandler in interface WriteStream<Buffer>
      Parameters:
      handler - the exception handler
      Returns:
      this instance of a stream

    • handler

      QuicStream handler(Handler<Buffer> handler)
      Set the handler signaled with the data events the remote peer has sent.
      Specified by:
      handler in interface ReadStream<Buffer>
      Specified by:
      handler in interface StreamChannel
      Parameters:
      handler - the data event handler
      Returns:
      this instance of a stream

    • pause

      QuicStream 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>
      Specified by:
      pause in interface StreamChannel
      Returns:
      a reference to this, so the API can be used fluently

    • resume

      QuicStream 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>
      Specified by:
      resume in interface StreamChannel
      Returns:
      a reference to this, so the API can be used fluently

    • fetch

      QuicStream 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>
      Specified by:
      fetch in interface StreamChannel
      Returns:
      a reference to this, so the API can be used fluently

    • endHandler

      QuicStream endHandler(Handler<Void> endHandler)
      Description copied from interface: StreamChannel
      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>
      Specified by:
      endHandler in interface StreamChannel
      Returns:
      a reference to this, so the API can be used fluently

    • setWriteQueueMaxSize

      QuicStream 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 StreamChannel
      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

      QuicStream 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 StreamChannel
      Specified by:
      drainHandler in interface WriteStream<Buffer>
      Parameters:
      handler - the handler
      Returns:
      a reference to this, so the API can be used fluently