org.eclipse.jetty.spdy

Interface IStream

All Superinterfaces:

Callback, Stream

All Known Implementing Classes:

StandardStream

public interface IStream
extends Stream, Callback

The internal interface that represents a stream.

IStream contains additional methods used by a SPDY implementation (and not by an application).

Nested Class Summary

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

Callback.Adapter

Method Summary

Methods

Modifier and Type	Method and Description
void	associate(IStream stream) Associate the given IStream to this IStream.
void	disassociate(IStream stream) remove the given associated IStream from this stream
IStream	getAssociatedStream() Overrides Stream.getAssociatedStream() to return an instance of IStream instead of Stream
StreamFrameListener	getStreamFrameListener()
int	getWindowSize() Senders of data frames need to know the current window size to determine whether they can send more data.
void	process(ControlFrame frame) Processes the given control frame, for example by updating the stream's state or by calling listeners.
void	process(DataInfo dataInfo) Processes the given dataInfo, for example by updating the stream's state or by calling listeners.
void	setStreamFrameListener(StreamFrameListener listener)
void	updateCloseState(boolean close, boolean local) A stream can be open, half closed or closed and this method updates the close state of this stream.
void	updateWindowSize(int delta) Updates the window size for this stream by the given amount, that can be positive or negative.

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

data, data, getAttribute, getId, getIdleTimeout, getPriority, getPushedStreams, getSession, headers, headers, isClosed, isHalfClosed, isReset, isUnidirectional, push, push, removeAttribute, reply, reply, setAttribute, setIdleTimeout

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

failed, succeeded

Method Detail

getWindowSize

int getWindowSize()

Senders of data frames need to know the current window size to determine whether they can send more data.

Returns:

the current window size for this stream.

See Also:

updateWindowSize(int)

updateWindowSize

void updateWindowSize(int delta)

Updates the window size for this stream by the given amount, that can be positive or negative.

Senders and recipients of data frames update the window size, respectively, with negative values and positive values.

Parameters:

delta - the signed amount the window size needs to be updated

See Also:

getWindowSize()

setStreamFrameListener

void setStreamFrameListener(StreamFrameListener listener)

Parameters:

listener - the stream frame listener associated to this stream as returned by SessionFrameListener.onSyn(Stream, SynInfo)

getStreamFrameListener

StreamFrameListener getStreamFrameListener()

Returns:

the stream frame listener associated to this stream

updateCloseState

void updateCloseState(boolean close,
                    boolean local)

A stream can be open, half closed or closed and this method updates the close state of this stream.

If the stream is open, calling this method with a value of true puts the stream into half closed state.

If the stream is half closed, calling this method with a value of true puts the stream into closed state.

Parameters:

close - whether the close state should be updated

local - whether the close is local or remote

process

void process(ControlFrame frame)

Processes the given control frame, for example by updating the stream's state or by calling listeners.

Parameters:

frame - the control frame to process

See Also:

process(DataInfo)

process

void process(DataInfo dataInfo)

Processes the given dataInfo, for example by updating the stream's state or by calling listeners.

Parameters:

dataInfo - the DataInfo to process

See Also:

process(ControlFrame)

associate

void associate(IStream stream)

Associate the given IStream to this IStream.

Parameters:

stream - the stream to associate with this stream

disassociate

void disassociate(IStream stream)

remove the given associated IStream from this stream

Parameters:

stream - the stream to be removed

getAssociatedStream

IStream getAssociatedStream()

Overrides Stream.getAssociatedStream() to return an instance of IStream instead of Stream

Specified by:

getAssociatedStream in interface Stream

Returns:

the associated parent stream or null if this is not an associated stream

See Also:

Stream.getAssociatedStream()