org.eclipse.jetty.spdy

Class StandardSession

java.lang.Object

org.eclipse.jetty.spdy.StandardSession

All Implemented Interfaces:

EventListener, Session, ISession, Parser.Listener, Dumpable

public class StandardSession
extends Object
implements ISession, Parser.Listener, Dumpable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	StandardSession.CloseFrameBytes
protected class	StandardSession.ControlFrameBytes
protected class	StandardSession.DataFrameBytes
static interface	StandardSession.FrameBytes

Nested classes/interfaces inherited from interface org.eclipse.jetty.spdy.api.Session

Session.Listener, Session.StreamListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.spdy.parser.Parser.Listener

Parser.Listener.Adapter

Constructor Summary

Constructors

Constructor and Description
StandardSession(short version, ByteBufferPool bufferPool, Scheduler scheduler, Controller controller, EndPoint endPoint, IdleListener idleListener, int initialStreamId, SessionFrameListener listener, Generator generator, FlowControlStrategy flowControlStrategy)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(Session.Listener listener) Registers the given listener to be notified of session events.
protected void	close()
void	control(IStream stream, ControlFrame frame, long timeout, TimeUnit unit, Callback callback)
void	data(IStream stream, DataInfo dataInfo, long timeout, TimeUnit unit, Callback callback)
String	dump()
void	dump(Appendable out, String indent)
Object	getAttribute(String key)
InetSocketAddress	getLocalAddress()
InetSocketAddress	getRemoteAddress()
IStream	getStream(int streamId)
Set<Stream>	getStreams()
short	getVersion()
int	getWindowSize()
void	goAway(GoAwayInfo goAwayInfo) Closes gracefully this session, sending a GO_AWAY frame and then closing the TCP connection.
void	goAway(GoAwayInfo goAwayInfo, Callback callback) Closes gracefully this session, sending a GO_AWAY frame and then closing the TCP connection.
void	onControlFrame(ControlFrame frame)
void	onDataFrame(DataFrame frame, ByteBuffer data)
void	onSessionException(SessionException x)
void	onStreamException(StreamException x)
PingResultInfo	ping(PingInfo pingInfo) Sends synchronously a PING, normally to measure round-trip time.
void	ping(PingInfo pingInfo, Promise<PingResultInfo> promise) Sends asynchronously a PING, normally to measure round-trip time.
Object	removeAttribute(String key)
void	removeListener(Session.Listener listener) Deregisters the give listener from being notified of session events.
void	rst(RstInfo rstInfo) Sends synchronously a RST_STREAM to abort a stream.
void	rst(RstInfo rstInfo, Callback callback) Sends asynchronously a RST_STREAM to abort a stream.
void	setAttribute(String key, Object value)
void	settings(SettingsInfo settingsInfo) Sends synchronously a SETTINGS to configure the SPDY connection.
void	settings(SettingsInfo settingsInfo, Callback callback) Sends asynchronously a SETTINGS to configure the SPDY connection.
void	setWindowSize(int initialWindowSize)
void	shutdown() Gracefully shuts down this session.
Stream	syn(SynInfo synInfo, StreamFrameListener listener) Sends a SYN_FRAME to create a new SPDY stream.
void	syn(SynInfo synInfo, StreamFrameListener listener, Promise<Stream> promise) Sends asynchronously a SYN_FRAME to create a new SPDY stream.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardSession

public StandardSession(short version,
               ByteBufferPool bufferPool,
               Scheduler scheduler,
               Controller controller,
               EndPoint endPoint,
               IdleListener idleListener,
               int initialStreamId,
               SessionFrameListener listener,
               Generator generator,
               FlowControlStrategy flowControlStrategy)

Method Detail

getVersion

public short getVersion()

Specified by:

getVersion in interface Session

Returns:

the SPDY protocol version used by this session

addListener

public void addListener(Session.Listener listener)

Description copied from interface: Session

Registers the given listener to be notified of session events.

Specified by:

addListener in interface Session

Parameters:

listener - the listener to register

See Also:

Session.removeListener(Listener)

removeListener

public void removeListener(Session.Listener listener)

Description copied from interface: Session

Deregisters the give listener from being notified of session events.

Specified by:

removeListener in interface Session

Parameters:

listener - the listener to deregister

See Also:

Session.addListener(Listener)

syn

public Stream syn(SynInfo synInfo,
         StreamFrameListener listener)
           throws ExecutionException,
                  InterruptedException,
                  TimeoutException

Description copied from interface: Session

Sends a SYN_FRAME to create a new SPDY stream.

Callers may use the returned Stream for example, to send data frames.

Specified by:

syn in interface Session

Parameters:

synInfo - the metadata to send on stream creation

listener - the listener to invoke when events happen on the stream just created

Returns:

the stream that will be created

Throws:

ExecutionException

InterruptedException

TimeoutException

See Also:

Session.syn(SynInfo, StreamFrameListener, Promise)

syn

public void syn(SynInfo synInfo,
       StreamFrameListener listener,
       Promise<Stream> promise)

Description copied from interface: Session

Sends asynchronously a SYN_FRAME to create a new SPDY stream.

Callers may pass a non-null completion callback to be notified of when the stream has been created and use the stream, for example, to send data frames.

Specified by:

syn in interface Session

Parameters:

synInfo - the metadata to send on stream creation

listener - the listener to invoke when events happen on the stream just created

promise - the completion callback that gets notified of stream creation

See Also:

Session.syn(SynInfo, StreamFrameListener)

rst

public void rst(RstInfo rstInfo)
         throws InterruptedException,
                ExecutionException,
                TimeoutException

Description copied from interface: Session

Sends synchronously a RST_STREAM to abort a stream.

Specified by:

rst in interface Session

Parameters:

rstInfo - the metadata to reset the stream

Throws:

InterruptedException

ExecutionException

TimeoutException

See Also:

Session.rst(RstInfo, Callback)

rst

public void rst(RstInfo rstInfo,
       Callback callback)

Description copied from interface: Session

Sends asynchronously a RST_STREAM to abort a stream.

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

Specified by:

rst in interface Session

Parameters:

rstInfo - the metadata to reset the stream

callback - the completion callback that gets notified of reset's send

See Also:

Session.rst(RstInfo)

settings

public void settings(SettingsInfo settingsInfo)
              throws ExecutionException,
                     InterruptedException,
                     TimeoutException

Description copied from interface: Session

Sends synchronously a SETTINGS to configure the SPDY connection.

Specified by:

settings in interface Session

Parameters:

settingsInfo - the metadata to send

Throws:

ExecutionException

InterruptedException

TimeoutException

See Also:

Session.settings(SettingsInfo, Callback)

settings

public void settings(SettingsInfo settingsInfo,
            Callback callback)

Description copied from interface: Session

Sends asynchronously a SETTINGS to configure the SPDY connection.

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

Specified by:

settings in interface Session

Parameters:

settingsInfo - the metadata to send

callback - the completion callback that gets notified of settings' send

See Also:

Session.settings(SettingsInfo)

ping

public PingResultInfo ping(PingInfo pingInfo)
                    throws ExecutionException,
                           InterruptedException,
                           TimeoutException

Description copied from interface: Session

Sends synchronously a PING, normally to measure round-trip time.

Specified by:

ping in interface Session

Throws:

ExecutionException

InterruptedException

TimeoutException

See Also:

Session.ping(PingInfo, Promise)

ping

public void ping(PingInfo pingInfo,
        Promise<PingResultInfo> promise)

Description copied from interface: Session

Sends asynchronously a PING, normally to measure round-trip time.

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

Specified by:

ping in interface Session

promise - the completion callback that gets notified of ping's send

See Also:

Session.ping(PingInfo)

goAway

public void goAway(GoAwayInfo goAwayInfo)
            throws ExecutionException,
                   InterruptedException,
                   TimeoutException

Description copied from interface: Session

Closes gracefully this session, sending a GO_AWAY frame and then closing the TCP connection.

Specified by:

goAway in interface Session

Throws:

ExecutionException

InterruptedException

TimeoutException

See Also:

Session.goAway(GoAwayInfo, Callback)

goAway

public void goAway(GoAwayInfo goAwayInfo,
          Callback callback)

Description copied from interface: Session

Closes gracefully this session, sending a GO_AWAY frame and then closing the TCP connection.

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

Specified by:

goAway in interface Session

callback - the completion callback that gets notified of go away's send

See Also:

Session.goAway(GoAwayInfo)

getStreams

public Set<Stream> getStreams()

Specified by:

getStreams in interface Session

Returns:

a snapshot of the streams currently active in this session

See Also:

Session.getStream(int)

getStream

public IStream getStream(int streamId)

Specified by:

getStream in interface Session

Parameters:

streamId - the id of the stream to retrieve

Returns:

the stream with the given stream id

See Also:

Session.getStreams()

getAttribute

public Object getAttribute(String key)

Specified by:

getAttribute in interface Session

Parameters:

key - the attribute key

Returns:

an arbitrary object associated with the given key to this session

See Also:

Session.setAttribute(String, Object)

setAttribute

public void setAttribute(String key,
                Object value)

Specified by:

setAttribute in interface Session

Parameters:

key - the attribute key

value - an arbitrary object to associate with the given key to this session

See Also:

Session.getAttribute(String), Session.removeAttribute(String)

removeAttribute

public Object removeAttribute(String key)

Specified by:

removeAttribute in interface Session

Parameters:

key - the attribute key

Returns:

the arbitrary object associated with the given key to this session

See Also:

Session.setAttribute(String, Object)

getLocalAddress

public InetSocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface Session

Returns:

the local address of the underlying endpoint

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface Session

Returns:

the remote address of the underlying endpoint

onControlFrame

public void onControlFrame(ControlFrame frame)

Specified by:

onControlFrame in interface Parser.Listener

onDataFrame

public void onDataFrame(DataFrame frame,
               ByteBuffer data)

Specified by:

onDataFrame in interface Parser.Listener

onStreamException

public void onStreamException(StreamException x)

Specified by:

onStreamException in interface Parser.Listener

onSessionException

public void onSessionException(SessionException x)

Specified by:

onSessionException in interface Parser.Listener

close

protected void close()

control

public void control(IStream stream,
           ControlFrame frame,
           long timeout,
           TimeUnit unit,
           Callback callback)

Specified by:

control in interface ISession

data

public void data(IStream stream,
        DataInfo dataInfo,
        long timeout,
        TimeUnit unit,
        Callback callback)

Specified by:

data in interface ISession

shutdown

public void shutdown()

Description copied from interface: ISession

Gracefully shuts down this session.

A special item is queued that will close the connection when it will be dequeued.

Specified by:

shutdown in interface ISession

getWindowSize

public int getWindowSize()

setWindowSize

public void setWindowSize(int initialWindowSize)

toString

public String toString()

Overrides:

toString in class Object

dump

public String dump()

Specified by:

dump in interface Dumpable

dump

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

Specified by:

dump in interface Dumpable

Throws:

IOException