Module org.eclipse.jetty.http2.common

Package org.eclipse.jetty.http2

Class HTTP2Stream

java.lang.Object

org.eclipse.jetty.http2.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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HTTP2Stream.FrameList	An ordered list of frames belonging to the same stream.

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.Callback

org.eclipse.jetty.util.Callback.Completable, org.eclipse.jetty.util.Callback.Completing, org.eclipse.jetty.util.Callback.Nested

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

org.eclipse.jetty.util.component.Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.thread.Invocable

org.eclipse.jetty.util.thread.Invocable.Callable, org.eclipse.jetty.util.thread.Invocable.InvocationType, org.eclipse.jetty.util.thread.Invocable.ReadyTask, org.eclipse.jetty.util.thread.Invocable.Task

Nested classes/interfaces inherited from interface org.eclipse.jetty.http2.api.Stream

Stream.Data, Stream.Listener

Field Summary

Fields inherited from interface org.eclipse.jetty.util.Callback

NOOP

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Fields inherited from interface org.eclipse.jetty.util.thread.Invocable

__nonBlocking

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	close()
void	commit()
void	data(DataFrame frame, org.eclipse.jetty.util.Callback callback)	Sends the given DATA frame.
void	demand()	Demands more DATA frames for this stream.
String	dump()
void	dump(Appendable out, String indent)
boolean	equals(Object o)
void	failed(Throwable x)
Object	getAttachment()
Object	getAttribute(String key)
long	getDataLength()
long	getExpireNanoTime()
int	getId()	Get the stream unique id.
long	getIdleTimeout()
org.eclipse.jetty.util.thread.Invocable.InvocationType	getInvocationType()
Stream.Listener	getListener()	Get the Stream.Listener associated with this stream.
int	getRecvWindow()
int	getSendWindow()
HTTP2Session	getSession()	Get the session this stream is associated to.
int	hashCode()
void	headers(HeadersFrame frame, org.eclipse.jetty.util.Callback callback)	Sends the given HEADERS frame.
boolean	isClosed()
boolean	isCommitted()
boolean	isLocal()
boolean	isLocallyClosed()
boolean	isOpen()
boolean	isRemotelyClosed()
boolean	isReset()
boolean	isResetOrFailed()
void	notIdle()
protected void	notifyHeaders(Stream stream, HeadersFrame frame)
void	onClose()
protected void	onIdleTimeout(TimeoutException timeout)
void	process(Stream.Data data)
void	process(Frame frame, org.eclipse.jetty.util.Callback callback)
void	processData()
void	push(PushPromiseFrame frame, org.eclipse.jetty.util.Promise<Stream> promise, Stream.Listener listener)	Sends the given PUSH_PROMISE frame.
Stream.Data	readData()	Reads DATA frames from this stream, wrapping them in retainable Stream.Data objects.
Object	removeAttribute(String key)
void	reset(ResetFrame frame, org.eclipse.jetty.util.Callback callback)	Sends the given RST_STREAM frame.
void	send(HTTP2Stream.FrameList frameList, org.eclipse.jetty.util.Callback callback)
void	setAttachment(Object attachment)
void	setAttribute(String key, Object value)
void	setIdleTimeout(long idleTimeout)
void	setListener(Stream.Listener listener)
void	succeeded()
String	toString()
boolean	updateClose(boolean update, CloseState.Event event)
int	updateRecvWindow(int delta)
int	updateSendWindow(int delta)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.Callback

completeWith

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Methods inherited from interface org.eclipse.jetty.http2.api.Stream

data, headers, push, reset

Constructor Details

HTTP2Stream

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

Method Details

getId

public int getId()

Description copied from interface: Stream

Get the stream unique id.

Specified by:

getId in interface Stream

Returns:

the stream unique id

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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()

Description copied from interface: Stream

Get the session this stream is associated to.

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_STREAM 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:

• Stream.setAttribute(String, Object)

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:

• Stream.getAttribute(String)
• Stream.removeAttribute(String)

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:

• Stream.setAttribute(String, Object)

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:

• Stream.isClosed()

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:

• Stream.setIdleTimeout(long)

setIdleTimeout

public void setIdleTimeout(long idleTimeout)

Specified by:

setIdleTimeout in interface Stream

Parameters:

idleTimeout - the stream idle timeout

See Also:

• Stream.getIdleTimeout()
• Stream.Listener.onIdleTimeout(Stream, TimeoutException, Promise)

onIdleTimeout

protected void onIdleTimeout(TimeoutException timeout)

getListener

public Stream.Listener getListener()

Description copied from interface: Stream

Get the Stream.Listener associated with this stream.

Specified by:

getListener in interface Stream

Returns:

the Stream.Listener associated with this stream

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)

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, the flow control window has been enlarged by the DATA frame length; applications must call, either immediately or later (even asynchronously from a different thread) Retainable.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).

Once the returned Stream.Data object indicates that the end of the read side of the stream has been reached, further calls to this method will return a Stream.Data object with the same indication, although the instance may be different.

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:

• Stream.demand()
• Stream.Listener.onDataAvailable(Stream)

demand

public void demand()

Description copied from interface: Stream

Demands more DATA frames for this stream.

Calling this method causes Stream.Listener.onDataAvailable(Stream) to be invoked, possibly at a later time, when the stream has data to be read, but also when the stream has reached EOF.

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.

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:

• Stream.readData()
• Stream.Listener.onDataAvailable(Stream)

processData

public void processData()

getDataLength

public long getDataLength()

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

notifyHeaders

protected void notifyHeaders(Stream stream,
 HeadersFrame frame)

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