Package org.eclipse.jetty.http2

Class HTTP2Stream

java.lang.Object

org.eclipse.jetty.http2.HTTP2Stream

All Implemented Interfaces:

Closeable, AutoCloseable, Stream, IStream, CyclicTimeouts.Expirable, Attachable, Callback, Dumpable, Invocable

public class HTTP2Stream
extends Object
implements IStream, Callback, Dumpable, CyclicTimeouts.Expirable

Nested Class Summary

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

Callback.Completable, Callback.Completing, Callback.Nested

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

Dumpable.DumpableContainer

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

Invocable.InvocationType, Invocable.ReadyTask, Invocable.Task

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

IStream.FrameList

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

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(ISession session, int streamId, MetaData.Request request, boolean local)
HTTP2Stream(Scheduler scheduler, ISession session, int streamId, MetaData.Request request, boolean local)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	close()	Forcibly closes this stream.
void	commit()	Marks this stream as committed.
void	data(DataFrame frame, Callback callback)	Sends the given DATA frame.
int	dataSize()
void	demand(long n)	Demands n more DATA frames for this stream.
String	dump()
void	dump(Appendable out, String indent)	Dump this object (and children) into an Appendable using the provided indent after any new lines.
boolean	failAllData(Throwable x)	Fail all data queued in the stream and reset demand to 0.
void	failed(Throwable x)	Callback invoked when the operation fails.
Object	getAttachment()
Object	getAttribute(String key)
long	getExpireNanoTime()	Returns the expiration time in nanoseconds.
int	getId()
long	getIdleTimeout()
Invocable.InvocationType	getInvocationType()
Stream.Listener	getListener()
int	getRecvWindow()
int	getSendWindow()
ISession	getSession()
void	headers(HeadersFrame frame, 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()	Marks this stream as not idle so that the idle timeout is postponed.
void	onClose()
protected void	onIdleExpired(TimeoutException timeout)
void	process(Frame frame, Callback callback)	Processes the given frame, belonging to this stream.
void	push(PushPromiseFrame frame, Promise<Stream> promise, Stream.Listener listener)	Sends the given PUSH_PROMISE frame.
Object	removeAttribute(String key)
void	reset(ResetFrame frame, Callback callback)	Sends the given RST_STREAM frame.
void	send(IStream.FrameList frameList, Callback callback)	Sends the given list of frames.
void	setAttachment(Object attachment)	Attaches the given object to this stream for later retrieval.
void	setAttribute(String key, Object value)
void	setIdleTimeout(long idleTimeout)
void	setListener(Stream.Listener listener)
void	succeeded()	Callback invoked when the operation completes.
String	toString()
boolean	updateClose(boolean update, CloseState.Event event)	Updates the close state of this stream.
int	updateRecvWindow(int delta)	Updates the stream receive window by the given delta.
int	updateSendWindow(int delta)	Updates the stream send window by the given delta.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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

Constructor Details

HTTP2Stream

public HTTP2Stream(ISession session,
 int streamId,
 MetaData.Request request,
 boolean local)

HTTP2Stream

@Deprecated
public HTTP2Stream(Scheduler scheduler,
 ISession session,
 int streamId,
 MetaData.Request request,
 boolean local)

Deprecated.

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 Attachable

Returns:

the object attached to this instance

See Also:

• Attachable.setAttachment(Object)

setAttachment

public void setAttachment(Object attachment)

Description copied from interface: Attachable

Attaches the given object to this stream for later retrieval.

Specified by:

setAttachment in interface Attachable

Parameters:

attachment - the object to attach to this instance

isLocal

public boolean isLocal()

Specified by:

isLocal in interface IStream

Returns:

whether this stream is local or remote

getSession

public ISession getSession()

Specified by:

getSession in interface IStream

Specified by:

getSession in interface Stream

Returns:

the session this stream is associated to

headers

public void headers(HeadersFrame frame,
 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(IStream.FrameList frameList,
 Callback callback)

Description copied from interface: IStream

Sends the given list of frames.

Typically used to send HTTP headers along with content and possibly trailers.

Specified by:

send in interface IStream

Parameters:

frameList - the list of frames to send

callback - the callback that gets notified when the frames have been sent

push

public void push(PushPromiseFrame frame,
 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,
 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,
 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:

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

Specified by:

isResetOrFailed in interface IStream

Returns:

whether this stream has been reset (locally or remotely) or has been failed

See Also:

• Stream.isReset()
• Stream.Listener.onFailure(Stream, int, String, Throwable, Callback)

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 IStream

Returns:

whether the stream is closed remotely.

See Also:

• Stream.isClosed()

failAllData

public boolean failAllData(Throwable x)

Description copied from interface: IStream

Fail all data queued in the stream and reset demand to 0.

Specified by:

failAllData in interface IStream

Parameters:

x - the exception to fail the data with.

Returns:

true if the end of the stream was reached, false otherwise.

isLocallyClosed

public boolean isLocallyClosed()

commit

public void commit()

Description copied from interface: IStream

Marks this stream as committed.

Specified by:

commit in interface IStream

See Also:

• IStream.isCommitted()

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface IStream

Returns:

whether bytes for this stream have been sent to the remote peer.

See Also:

• IStream.commit()

dataSize

public int dataSize()

Specified by:

dataSize in interface IStream

Returns:

the size of the DATA frame queue

isOpen

public boolean isOpen()

notIdle

public void notIdle()

Description copied from interface: IStream

Marks this stream as not idle so that the idle timeout is postponed.

Specified by:

notIdle in interface IStream

getExpireNanoTime

public long getExpireNanoTime()

Description copied from interface: CyclicTimeouts.Expirable

Returns the expiration time in nanoseconds.

The value to return must be calculated taking into account the current nanoTime, for example:

expireNanoTime = NanoTime.now() + timeoutNanos

Returning Long.MAX_VALUE indicates that this entity does not expire.

Specified by:

getExpireNanoTime in interface CyclicTimeouts.Expirable

Returns:

the expiration time in nanoseconds, or Long.MAX_VALUE if this entity does not expire

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, Throwable)

onIdleExpired

protected void onIdleExpired(TimeoutException timeout)

getListener

public Stream.Listener getListener()

Specified by:

getListener in interface IStream

Returns:

the Stream.Listener associated with this stream

See Also:

• IStream.setListener(Stream.Listener)

setListener

public void setListener(Stream.Listener listener)

Specified by:

setListener in interface IStream

Parameters:

listener - the Stream.Listener associated with this stream

See Also:

• IStream.getListener()

process

public void process(Frame frame,
 Callback callback)

Description copied from interface: IStream

Processes the given frame, belonging to this stream.

Specified by:

process in interface IStream

Parameters:

frame - the frame to process

callback - the callback to complete when frame has been processed

demand

public void demand(long n)

Description copied from interface: Stream

Demands n more DATA frames for this stream.

Specified by:

demand in interface Stream

Parameters:

n - the increment of the demand, must be greater than zero

See Also:

• Stream.Listener.onDataDemanded(Stream, DataFrame, Callback)

updateClose

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

Description copied from interface: IStream

Updates the close state of this stream.

Specified by:

updateClose in interface IStream

Parameters:

update - whether to update the close state

event - the event that caused the close state update

Returns:

whether the stream has been fully closed by this invocation

getSendWindow

public int getSendWindow()

getRecvWindow

public int getRecvWindow()

updateSendWindow

public int updateSendWindow(int delta)

Description copied from interface: IStream

Updates the stream send window by the given delta.

Specified by:

updateSendWindow in interface IStream

Parameters:

delta - the delta value (positive or negative) to add to the stream send window

Returns:

the previous value of the stream send window

updateRecvWindow

public int updateRecvWindow(int delta)

Description copied from interface: IStream

Updates the stream receive window by the given delta.

Specified by:

updateRecvWindow in interface IStream

Parameters:

delta - the delta value (positive or negative) to add to the stream receive window

Returns:

the previous value of the stream receive window

close

public void close()

Description copied from interface: IStream

Forcibly closes this stream.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface IStream

onClose

public void onClose()

succeeded

public void succeeded()

Description copied from interface: Callback

Callback invoked when the operation completes.

Specified by:

succeeded in interface Callback

See Also:

• Callback.failed(Throwable)

failed

public void failed(Throwable x)

Description copied from interface: Callback

Callback invoked when the operation fails.

Specified by:

failed in interface Callback

Parameters:

x - the reason for the operation failure

getInvocationType

public Invocable.InvocationType getInvocationType()

Specified by:

getInvocationType in interface Invocable

Returns:

The InvocationType of this object

dump

public String dump()

Specified by:

dump in interface Dumpable

dump

public void dump(Appendable out,
 String indent)
          throws IOException

Description copied from interface: Dumpable

Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.

Specified by:

dump in interface Dumpable

Parameters:

out - The appendable to dump to

indent - The indent to apply after any new lines.

Throws:

IOException - if unable to write to Appendable

toString

public String toString()

Overrides:

toString in class Object