Module org.eclipse.jetty.http2.common
Package org.eclipse.jetty.http2.internal

Class HTTP2Stream

java.lang.Object
org.eclipse.jetty.http2.internal.HTTP2Stream
All Implemented Interfaces:
Closeable, AutoCloseable, Stream, org.eclipse.jetty.io.CyclicTimeouts.Expirable, org.eclipse.jetty.util.Attachable, org.eclipse.jetty.util.Callback, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.thread.Invocable
public class HTTP2Stream extends Object implements Stream, org.eclipse.jetty.util.Attachable, Closeable, org.eclipse.jetty.util.Callback, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.io.CyclicTimeouts.Expirable

  • Constructor Details

    • HTTP2Stream

      public HTTP2Stream(HTTP2Session session, int streamId, org.eclipse.jetty.http.MetaData.Request request, boolean local)

  • Method Details

    • getId

      public int getId()
      Specified by:
      getId in interface Stream
      Returns:
      the stream unique id

    • getAttachment

      public Object getAttachment()
      Specified by:
      getAttachment in interface org.eclipse.jetty.util.Attachable

    • setAttachment

      public void setAttachment(Object attachment)
      Specified by:
      setAttachment in interface org.eclipse.jetty.util.Attachable

    • isLocal

      public boolean isLocal()
      Specified by:
      isLocal in interface Stream
      Returns:
      whether this stream is local or remote

    • getSession

      public HTTP2Session getSession()
      Specified by:
      getSession in interface Stream
      Returns:
      the session this stream is associated to

    • headers

      public void headers(HeadersFrame frame, org.eclipse.jetty.util.Callback callback)
      Description copied from interface: Stream

      Sends the given HEADERS frame.

      Typically used to send an HTTP response or to send the HTTP response trailers.

      Specified by:
      headers in interface Stream
      Parameters:
      frame - the HEADERS frame to send
      callback - the callback that gets notified when the frame has been sent

    • send

      public void send(HTTP2Stream.FrameList frameList, org.eclipse.jetty.util.Callback callback)

    • push

      public void push(PushPromiseFrame frame, org.eclipse.jetty.util.Promise<Stream> promise, Stream.Listener listener)
      Description copied from interface: Stream

      Sends the given PUSH_PROMISE frame.

      Specified by:
      push in interface Stream
      Parameters:
      frame - the PUSH_PROMISE frame to send
      promise - the promise that gets notified of the pushed stream creation
      listener - the listener that gets notified of stream events

    • data

      public void data(DataFrame frame, org.eclipse.jetty.util.Callback callback)
      Description copied from interface: Stream

      Sends the given DATA frame.

      Specified by:
      data in interface Stream
      Parameters:
      frame - the DATA frame to send
      callback - the callback that gets notified when the frame has been sent

    • reset

      public void reset(ResetFrame frame, org.eclipse.jetty.util.Callback callback)
      Description copied from interface: Stream

      Sends the given RST_STREAM frame.

      Specified by:
      reset in interface Stream
      Parameters:
      frame - the RST_FRAME to send
      callback - the callback that gets notified when the frame has been sent

    • getAttribute

      public Object getAttribute(String key)
      Specified by:
      getAttribute in interface Stream
      Parameters:
      key - the attribute key
      Returns:
      an arbitrary object associated with the given key to this stream or null if no object can be found for the given key.
      See Also:

    • setAttribute

      public void setAttribute(String key, Object value)
      Specified by:
      setAttribute in interface Stream
      Parameters:
      key - the attribute key
      value - an arbitrary object to associate with the given key to this stream
      See Also:

    • removeAttribute

      public Object removeAttribute(String key)
      Specified by:
      removeAttribute in interface Stream
      Parameters:
      key - the attribute key
      Returns:
      the arbitrary object associated with the given key to this stream
      See Also:

    • isReset

      public boolean isReset()
      Specified by:
      isReset in interface Stream
      Returns:
      whether this stream has been reset

    • isResetOrFailed

      public boolean isResetOrFailed()

    • isClosed

      public boolean isClosed()
      Specified by:
      isClosed in interface Stream
      Returns:
      whether this stream is closed, both locally and remotely.

    • isRemotelyClosed

      public boolean isRemotelyClosed()
      Specified by:
      isRemotelyClosed in interface Stream
      Returns:
      whether the stream is closed remotely.
      See Also:

    • isLocallyClosed

      public boolean isLocallyClosed()

    • commit

      public void commit()

    • isCommitted

      public boolean isCommitted()

    • isOpen

      public boolean isOpen()

    • notIdle

      public void notIdle()

    • getExpireNanoTime

      public long getExpireNanoTime()
      Specified by:
      getExpireNanoTime in interface org.eclipse.jetty.io.CyclicTimeouts.Expirable

    • getIdleTimeout

      public long getIdleTimeout()
      Specified by:
      getIdleTimeout in interface Stream
      Returns:
      the stream idle timeout
      See Also:

    • setIdleTimeout

      public void setIdleTimeout(long idleTimeout)
      Specified by:
      setIdleTimeout in interface Stream
      Parameters:
      idleTimeout - the stream idle timeout
      See Also:

    • onIdleExpired

      protected void onIdleExpired(TimeoutException timeout)

    • getListener

      public Stream.Listener getListener()
      Specified by:
      getListener in interface Stream
      Returns:
      the Stream.Listener associated with this stream

    • readData

      public Stream.Data readData()
      Description copied from interface: Stream

      Reads DATA frames from this stream, wrapping them in retainable Stream.Data objects.

      The returned Stream.Data object may be null, indicating that the end of the read side of the stream has not yet been reached, which may happen in these cases:

      • not all the bytes have been received so far, for example the remote peer did not send them yet, or they are in-flight
      • all the bytes have been received, but there is a trailer HEADERS frame to be received to indicate the end of the read side of the stream

      When the returned Stream.Data object is not null, applications must call, either immediately or later (possibly asynchronously) Stream.Data.release() to notify the implementation that the bytes have been processed.

      Stream.Data objects may be stored away for later, asynchronous, processing (for example, to process them only when all of them have been received).

      Specified by:
      readData in interface Stream
      Returns:
      a Stream.Data object containing the DATA frame, or null if no DATA frame is available
      See Also:

    • setListener

      public void setListener(Stream.Listener listener)

    • process

      public void process(Frame frame, org.eclipse.jetty.util.Callback callback)

    • process

      public void process(Stream.Data data)

    • demand

      public void demand()
      Description copied from interface: Stream

      Demands more DATA frames for this stream, causing Stream.Listener.onDataAvailable(Stream) to be invoked, possibly at a later time, when the stream has data to be read.

      This method is idempotent: calling it when there already is an outstanding demand to invoke Stream.Listener.onDataAvailable(Stream) is a no-operation.

      The thread invoking this method may invoke directly Stream.Listener.onDataAvailable(Stream), unless another thread that must invoke Stream.Listener.onDataAvailable(Stream) notices the outstanding demand first.

      When all bytes have been read (via Stream.readData()), further invocations of this method are a no-operation.

      It is always guaranteed that invoking this method from within onDataAvailable(Stream) will not cause a StackOverflowError.

      Specified by:
      demand in interface Stream
      See Also:

    • processData

      public void processData()

    • updateClose

      public boolean updateClose(boolean update, CloseState.Event event)

    • getSendWindow

      public int getSendWindow()

    • getRecvWindow

      public int getRecvWindow()

    • updateSendWindow

      public int updateSendWindow(int delta)

    • updateRecvWindow

      public int updateRecvWindow(int delta)

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable

    • onClose

      public void onClose()

    • succeeded

      public void succeeded()
      Specified by:
      succeeded in interface org.eclipse.jetty.util.Callback

    • failed

      public void failed(Throwable x)
      Specified by:
      failed in interface org.eclipse.jetty.util.Callback

    • getInvocationType

      public org.eclipse.jetty.util.thread.Invocable.InvocationType getInvocationType()
      Specified by:
      getInvocationType in interface org.eclipse.jetty.util.thread.Invocable

    • dump

      public String dump()
      Specified by:
      dump in interface org.eclipse.jetty.util.component.Dumpable

    • dump

      public void dump(Appendable out, String indent) throws IOException
      Specified by:
      dump in interface org.eclipse.jetty.util.component.Dumpable
      Throws:
      IOException

    • toString

      public String toString()
      Overrides:
      toString in class Object