org.eclipse.jetty.spdy

Class StandardSession

java.lang.Object

org.eclipse.jetty.spdy.StandardSession

All Implemented Interfaces:

EventListener, Handler<StandardSession.FrameBytes>, Session, ISession, Parser.Listener, Dumpable

public class StandardSession
extends Object
implements ISession, Parser.Listener, Handler<StandardSession.FrameBytes>, Dumpable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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

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

Handler.Adapter<C>

Constructor Summary

Constructors

Constructor and Description
StandardSession(short version, ByteBufferPool bufferPool, Executor threadPool, ScheduledExecutorService scheduler, Controller<StandardSession.FrameBytes> controller, 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	completed(StandardSession.FrameBytes frameBytes) Callback invoked when the operation completes.
<C> void	control(IStream stream, ControlFrame frame, long timeout, TimeUnit unit, Handler<C> handler, C context)
<C> void	data(IStream stream, DataInfo dataInfo, long timeout, TimeUnit unit, Handler<C> handler, C context)
String	dump()
void	dump(Appendable out, String indent)
void	failed(StandardSession.FrameBytes frameBytes, Throwable x) Callback invoked when the operation fails.
void	flush() Initiates the flush of data to the other peer.
Object	getAttribute(String key)
IStream	getStream(int streamId)
Set<Stream>	getStreams()
short	getVersion()
int	getWindowSize()
Future<Void>	goAway() Closes gracefully this session, sending a GO_AWAY frame and then closing the TCP connection.
void	goAway(long timeout, TimeUnit unit, Handler<Void> handler) 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)
Future<PingInfo>	ping() Sends asynchronously a PING, normally to measure round-trip time.
void	ping(long timeout, TimeUnit unit, Handler<PingInfo> handler) 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.
Future<Void>	rst(RstInfo rstInfo) Sends asynchronously a RST_STREAM to abort a stream.
void	rst(RstInfo rstInfo, long timeout, TimeUnit unit, Handler<Void> handler) Sends asynchronously a RST_STREAM to abort a stream.
void	setAttribute(String key, Object value)
Future<Void>	settings(SettingsInfo settingsInfo) Sends asynchronously a SETTINGS to configure the SPDY connection.
void	settings(SettingsInfo settingsInfo, long timeout, TimeUnit unit, Handler<Void> handler) Sends asynchronously a SETTINGS to configure the SPDY connection.
void	setWindowSize(int initialWindowSize)
Future<Stream>	syn(SynInfo synInfo, StreamFrameListener listener) Sends asynchronously a SYN_FRAME to create a new SPDY stream.
void	syn(SynInfo synInfo, StreamFrameListener listener, long timeout, TimeUnit unit, Handler<Stream> handler) Sends asynchronously a SYN_FRAME to create a new SPDY stream.
String	toString()
protected void	write(ByteBuffer buffer, Handler<StandardSession.FrameBytes> handler, StandardSession.FrameBytes frameBytes)

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,
               Executor threadPool,
               ScheduledExecutorService scheduler,
               Controller<StandardSession.FrameBytes> controller,
               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 Future<Stream> syn(SynInfo synInfo,
                 StreamFrameListener listener)

Description copied from interface: Session

Sends asynchronously a SYN_FRAME to create a new SPDY stream.

Callers may use the returned future to wait for the stream to be 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

Returns:

a future for the stream that will be created

See Also:

Session.syn(SynInfo, StreamFrameListener, long, TimeUnit, Handler)

syn

public void syn(SynInfo synInfo,
       StreamFrameListener listener,
       long timeout,
       TimeUnit unit,
       Handler<Stream> handler)

Description copied from interface: Session

Sends asynchronously a SYN_FRAME to create a new SPDY stream.

Callers may pass a non-null completion handler 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

timeout - the operation's timeout

unit - the timeout's unit

handler - the completion handler that gets notified of stream creation

See Also:

Session.syn(SynInfo, StreamFrameListener)

rst

public Future<Void> rst(RstInfo rstInfo)

Description copied from interface: Session

Sends asynchronously a RST_STREAM to abort a stream.

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

Specified by:

rst in interface Session

Parameters:

rstInfo - the metadata to reset the stream

Returns:

a future to wait for the reset to be sent

See Also:

Session.rst(RstInfo, long, TimeUnit, Handler)

rst

public void rst(RstInfo rstInfo,
       long timeout,
       TimeUnit unit,
       Handler<Void> handler)

Description copied from interface: Session

Sends asynchronously a RST_STREAM to abort a stream.

Callers may pass a non-null completion handler 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

timeout - the operation's timeout

unit - the timeout's unit

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

See Also:

Session.rst(RstInfo)

settings

public Future<Void> settings(SettingsInfo settingsInfo)

Description copied from interface: Session

Sends asynchronously a SETTINGS to configure the SPDY connection.

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

Specified by:

settings in interface Session

Parameters:

settingsInfo - the metadata to send

Returns:

a future to wait for the settings to be sent

See Also:

Session.settings(SettingsInfo, long, TimeUnit, Handler)

settings

public void settings(SettingsInfo settingsInfo,
            long timeout,
            TimeUnit unit,
            Handler<Void> handler)

Description copied from interface: Session

Sends asynchronously a SETTINGS to configure the SPDY connection.

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

Specified by:

settings in interface Session

Parameters:

settingsInfo - the metadata to send

timeout - the operation's timeout

unit - the timeout's unit

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

See Also:

Session.settings(SettingsInfo)

ping

public Future<PingInfo> ping()

Description copied from interface: Session

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

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

Specified by:

ping in interface Session

Returns:

a future for the metadata sent

See Also:

Session.ping(long, TimeUnit, Handler)

ping

public void ping(long timeout,
        TimeUnit unit,
        Handler<PingInfo> handler)

Description copied from interface: Session

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

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

Specified by:

ping in interface Session

Parameters:

timeout - the operation's timeout

unit - the timeout's unit

handler - the completion handler that gets notified of ping's send

See Also:

Session.ping()

goAway

public Future<Void> goAway()

Description copied from interface: Session

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

Callers may use the returned future to wait for the go away to be sent.

Specified by:

goAway in interface Session

Returns:

a future to wait for the go away to be sent

See Also:

Session.goAway(long, TimeUnit, Handler)

goAway

public void goAway(long timeout,
          TimeUnit unit,
          Handler<Void> handler)

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 handler to be notified of when the go away has been actually sent.

Specified by:

goAway in interface Session

Parameters:

timeout - the operation's timeout

unit - the timeout's unit

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

See Also:

Session.goAway()

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)

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 <C> void control(IStream stream,
               ControlFrame frame,
               long timeout,
               TimeUnit unit,
               Handler<C> handler,
               C context)

Specified by:

control in interface ISession

data

public <C> void data(IStream stream,
            DataInfo dataInfo,
            long timeout,
            TimeUnit unit,
            Handler<C> handler,
            C context)

Specified by:

data in interface ISession

flush

public void flush()

Description copied from interface: ISession

Initiates the flush of data to the other peer.

Note that the flush may do nothing if, for example, there is nothing to flush, or if the data to be flushed belong to streams that have their flow-control stalled.

Specified by:

flush in interface ISession

completed

public void completed(StandardSession.FrameBytes frameBytes)

Description copied from interface: Handler

Callback invoked when the operation completes.

Specified by:

completed in interface Handler<StandardSession.FrameBytes>

Parameters:

frameBytes - the context

See Also:

Handler.failed(Object, Throwable)

failed

public void failed(StandardSession.FrameBytes frameBytes,
          Throwable x)

Description copied from interface: Handler

Callback invoked when the operation fails.

Specified by:

failed in interface Handler<StandardSession.FrameBytes>

Parameters:

frameBytes - the context

x - the reason for the operation failure

write

protected void write(ByteBuffer buffer,
         Handler<StandardSession.FrameBytes> handler,
         StandardSession.FrameBytes frameBytes)

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