org.eclipse.jetty.http2

Interface IStream

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, Stream

All Known Implementing Classes:

HTTP2Stream

public interface IStream
extends Stream, java.io.Closeable

The SPI interface for implementing a HTTP/2 stream.

This class extends Stream by adding the methods required to implement the HTTP/2 stream functionalities.

Nested Class Summary

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

Stream.Listener

Method Summary

Modifier and Type	Method and Description
void	close() Forcibly closes this stream.
java.lang.Object	getAttachment()
Stream.Listener	getListener()
ISession	getSession()
boolean	isLocal()
boolean	isRemotelyClosed()
void	notIdle() Marks this stream as not idle so that the idle timeout is postponed.
void	process(Frame frame, Callback callback) Processes the given frame, belonging to this stream.
void	setAttachment(java.lang.Object attachment) Attaches the given object to this stream for later retrieval.
void	setListener(Stream.Listener listener)
boolean	updateClose(boolean update, boolean local) 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 interface org.eclipse.jetty.http2.api.Stream

data, getAttribute, getId, getIdleTimeout, headers, isClosed, isReset, push, removeAttribute, reset, setAttribute, setIdleTimeout

Method Detail

getAttachment

java.lang.Object getAttachment()

Returns:

the object attached to this stream

See Also:

setAttachment(Object)

setAttachment

void setAttachment(java.lang.Object attachment)

Attaches the given object to this stream for later retrieval.

Parameters:

attachment - the object to attach to this stream

isLocal

boolean isLocal()

Returns:

whether this stream is local or remote

getSession

ISession getSession()

Specified by:

getSession in interface Stream

Returns:

the session this stream is associated to

getListener

Stream.Listener getListener()

Returns:

the Stream.Listener associated with this stream

See Also:

setListener(Stream.Listener)

setListener

void setListener(Stream.Listener listener)

Parameters:

listener - the Stream.Listener associated with this stream

See Also:

getListener()

process

void process(Frame frame,
             Callback callback)

Processes the given frame, belonging to this stream.

Parameters:

frame - the frame to process

callback - the callback to complete when frame has been processed

updateClose

boolean updateClose(boolean update,
                    boolean local)

Updates the close state of this stream.

Parameters:

update - whether to update the close state

local - whether the update comes from a local operation (such as sending a frame that ends the stream) or a remote operation (such as receiving a frame

Returns:

whether the stream has been fully closed by this invocation

close

void close()

Forcibly closes this stream.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

updateSendWindow

int updateSendWindow(int delta)

Updates the stream send window by the given delta.

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

int updateRecvWindow(int delta)

Updates the stream receive window by the given delta.

Parameters:

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

Returns:

the previous value of the stream receive window

notIdle

void notIdle()

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

isRemotelyClosed

boolean isRemotelyClosed()

Returns:

whether the stream is closed remotely.

See Also:

Stream.isClosed()