org.eclipse.jetty.spdy

Class StandardStream

java.lang.Object

org.eclipse.jetty.io.IdleTimeout

org.eclipse.jetty.spdy.StandardStream

All Implemented Interfaces:

Stream, IStream, Callback

public class StandardStream
extends IdleTimeout
implements IStream

Nested Class Summary

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

Callback.Adapter

Constructor Summary

Constructors

Constructor and Description
StandardStream(int id, byte priority, ISession session, IStream associatedStream, Scheduler scheduler, Promise<Stream> promise)

Method Summary

Methods

Modifier and Type	Method and Description
void	associate(IStream stream) Associate the given IStream to this IStream.
void	data(DataInfo dataInfo) Sends asynchronously a DATA frame on this stream.
void	data(DataInfo dataInfo, Callback callback) Sends asynchronously a DATA frame on this stream.
void	disassociate(IStream stream) remove the given associated IStream from this stream
void	failed(Throwable x) Callback invoked when the operation fails.
IStream	getAssociatedStream() Overrides Stream.getAssociatedStream() to return an instance of IStream instead of Stream
Object	getAttribute(String key)
int	getId()
byte	getPriority()
Set<Stream>	getPushedStreams()
ISession	getSession()
StreamFrameListener	getStreamFrameListener()
int	getWindowSize() Senders of data frames need to know the current window size to determine whether they can send more data.
void	headers(HeadersInfo headersInfo) Sends asynchronously a HEADER frame on this stream.
void	headers(HeadersInfo headersInfo, Callback callback) Sends asynchronously a HEADER frame on this stream.
boolean	isClosed()
boolean	isHalfClosed()
boolean	isOpen() This abstract method should be called to check if idle timeouts should still be checked.
boolean	isReset()
boolean	isUnidirectional()
protected void	onIdleExpired(TimeoutException timeout) This abstract method is called when the idle timeout has expired.
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.
Stream	push(PushInfo pushInfo) Initiate a unidirectional spdy pushstream associated to this stream asynchronously
void	push(PushInfo pushInfo, Promise<Stream> promise) Initiate a unidirectional spdy pushstream associated to this stream asynchronously
Object	removeAttribute(String key)
void	reply(ReplyInfo replyInfo) Sends asynchronously a SYN_REPLY frame in response to a SYN_STREAM frame.
void	reply(ReplyInfo replyInfo, Callback callback) Sends asynchronously a SYN_REPLY frame in response to a SYN_STREAM frame.
void	setAttribute(String key, Object value)
void	setStreamFrameListener(StreamFrameListener listener)
void	succeeded() Callback invoked when the operation completes.
String	toString()
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 class org.eclipse.jetty.io.IdleTimeout

checkIdleTimeout, getIdleTimeout, getIdleTimestamp, notIdle, onClose, onOpen, setIdleTimeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getIdleTimeout, setIdleTimeout

Constructor Detail

StandardStream

public StandardStream(int id,
              byte priority,
              ISession session,
              IStream associatedStream,
              Scheduler scheduler,
              Promise<Stream> promise)

Method Detail

getId

public int getId()

Specified by:

getId in interface Stream

Returns:

the id of this stream

getAssociatedStream

public IStream getAssociatedStream()

Description copied from interface: IStream

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

Specified by:

getAssociatedStream in interface Stream

Specified by:

getAssociatedStream in interface IStream

Returns:

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

See Also:

Stream.getAssociatedStream()

getPushedStreams

public Set<Stream> getPushedStreams()

Specified by:

getPushedStreams in interface Stream

Returns:

associated child streams or an empty set if no associated streams exist

associate

public void associate(IStream stream)

Description copied from interface: IStream

Associate the given IStream to this IStream.

Specified by:

associate in interface IStream

Parameters:

stream - the stream to associate with this stream

disassociate

public void disassociate(IStream stream)

Description copied from interface: IStream

remove the given associated IStream from this stream

Specified by:

disassociate in interface IStream

Parameters:

stream - the stream to be removed

getPriority

public byte getPriority()

Specified by:

getPriority in interface Stream

Returns:

the priority of this stream

onIdleExpired

protected void onIdleExpired(TimeoutException timeout)

Description copied from class: IdleTimeout

This abstract method is called when the idle timeout has expired.

Specified by:

onIdleExpired in class IdleTimeout

Parameters:

timeout - a TimeoutException

isOpen

public boolean isOpen()

Description copied from class: IdleTimeout

This abstract method should be called to check if idle timeouts should still be checked.

Specified by:

isOpen in class IdleTimeout

Returns:

True if the entity monitored should still be checked for idle timeouts

getWindowSize

public int getWindowSize()

Description copied from interface: IStream

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

Specified by:

getWindowSize in interface IStream

Returns:

the current window size for this stream.

See Also:

IStream.updateWindowSize(int)

updateWindowSize

public void updateWindowSize(int delta)

Description copied from interface: IStream

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.

Specified by:

updateWindowSize in interface IStream

Parameters:

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

See Also:

IStream.getWindowSize()

getSession

public ISession getSession()

Specified by:

getSession in interface Stream

Returns:

the session this stream is associated to

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)

setStreamFrameListener

public void setStreamFrameListener(StreamFrameListener listener)

Specified by:

setStreamFrameListener in interface IStream

Parameters:

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

getStreamFrameListener

public StreamFrameListener getStreamFrameListener()

Specified by:

getStreamFrameListener in interface IStream

Returns:

the stream frame listener associated to this stream

updateCloseState

public void updateCloseState(boolean close,
                    boolean local)

Description copied from interface: IStream

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.

Specified by:

updateCloseState in interface IStream

Parameters:

close - whether the close state should be updated

local - whether the close is local or remote

process

public void process(ControlFrame frame)

Description copied from interface: IStream

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

Specified by:

process in interface IStream

Parameters:

frame - the control frame to process

See Also:

IStream.process(DataInfo)

process

public void process(DataInfo dataInfo)

Description copied from interface: IStream

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

Specified by:

process in interface IStream

Parameters:

dataInfo - the DataInfo to process

See Also:

IStream.process(ControlFrame)

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

push

public Stream push(PushInfo pushInfo)
            throws InterruptedException,
                   ExecutionException,
                   TimeoutException

Description copied from interface: Stream

Initiate a unidirectional spdy pushstream associated to this stream asynchronously

Callers may use the returned future to get the pushstream once it got created

Specified by:

push in interface Stream

Parameters:

pushInfo - the metadata to send on stream creation

Returns:

a future containing the stream once it got established

Throws:

InterruptedException

ExecutionException

TimeoutException

See Also:

Stream.push(PushInfo, Promise)

push

public void push(PushInfo pushInfo,
        Promise<Stream> promise)

Description copied from interface: Stream

Initiate a unidirectional spdy pushstream associated to this stream asynchronously

Callers may pass a non-null completion promise to be notified of when the pushstream has been established.

Specified by:

push in interface Stream

Parameters:

pushInfo - the metadata to send on stream creation

promise - the completion promise that gets notified once the pushstream is established

See Also:

Stream.push(PushInfo)

reply

public void reply(ReplyInfo replyInfo)
           throws InterruptedException,
                  ExecutionException,
                  TimeoutException

Description copied from interface: Stream

Sends asynchronously a SYN_REPLY frame in response to a SYN_STREAM frame.

Callers may use the returned future to wait for the reply to be actually sent.

Specified by:

reply in interface Stream

Parameters:

replyInfo - the metadata to send

Throws:

InterruptedException

ExecutionException

TimeoutException

See Also:

Stream.reply(ReplyInfo, Callback), SessionFrameListener.onSyn(Stream, SynInfo)

reply

public void reply(ReplyInfo replyInfo,
         Callback callback)

Description copied from interface: Stream

Sends asynchronously a SYN_REPLY frame in response to a SYN_STREAM frame.

Callers may pass a non-null completion callback to be notified of when the reply has been actually sent.

Specified by:

reply in interface Stream

Parameters:

replyInfo - the metadata to send

callback - the completion callback that gets notified of reply sent

See Also:

Stream.reply(ReplyInfo)

data

public void data(DataInfo dataInfo)
          throws InterruptedException,
                 ExecutionException,
                 TimeoutException

Description copied from interface: Stream

Sends asynchronously a DATA frame on this stream.

DATA frames should always be sent after a SYN_REPLY frame.

Callers may use the returned future to wait for the data to be actually sent.

Specified by:

data in interface Stream

Parameters:

dataInfo - the metadata to send

Throws:

InterruptedException

ExecutionException

TimeoutException

See Also:

Stream.data(DataInfo, Callback), Stream.reply(ReplyInfo)

data

public void data(DataInfo dataInfo,
        Callback callback)

Description copied from interface: Stream

Sends asynchronously a DATA frame on this stream.

DATA frames should always be sent after a SYN_REPLY frame.

Callers may pass a non-null completion callback to be notified of when the data has been actually sent.

Specified by:

data in interface Stream

Parameters:

dataInfo - the metadata to send

callback - the completion callback that gets notified of data sent

See Also:

Stream.data(DataInfo)

headers

public void headers(HeadersInfo headersInfo)
             throws InterruptedException,
                    ExecutionException,
                    TimeoutException

Description copied from interface: Stream

Sends asynchronously a HEADER frame on this stream.

HEADERS frames should always be sent after a SYN_REPLY frame.

Callers may use the returned future to wait for the headers to be actually sent.

Specified by:

headers in interface Stream

Parameters:

headersInfo - the metadata to send

Throws:

InterruptedException

ExecutionException

TimeoutException

See Also:

Stream.headers(HeadersInfo, Callback), Stream.reply(ReplyInfo)

headers

public void headers(HeadersInfo headersInfo,
           Callback callback)

Description copied from interface: Stream

Sends asynchronously a HEADER frame on this stream.

HEADERS frames should always be sent after a SYN_REPLY frame.

Callers may pass a non-null completion callback to be notified of when the headers have been actually sent.

Specified by:

headers in interface Stream

Parameters:

headersInfo - the metadata to send

callback - the completion callback that gets notified of headers sent

See Also:

Stream.headers(HeadersInfo)

isUnidirectional

public boolean isUnidirectional()

Specified by:

isUnidirectional in interface Stream

Returns:

whether this stream is unidirectional or not

isReset

public boolean isReset()

Specified by:

isReset in interface Stream

Returns:

whether this stream has been reset

isHalfClosed

public boolean isHalfClosed()

Specified by:

isHalfClosed in interface Stream

Returns:

whether this stream has been closed by one party only

See Also:

Stream.isClosed()

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Stream

Returns:

whether this stream has been closed by both parties

See Also:

Stream.isHalfClosed()

toString

public String toString()

Overrides:

toString in class Object