org.eclipse.jetty.spdy.api

Interface Session

All Known Subinterfaces:

ISession

All Known Implementing Classes:

StandardSession

public interface Session

A Session represents the client-side endpoint of a SPDY connection to a single origin server.

Once a Session has been obtained, it can be used to open SPDY streams:

 Session session = ...;
 SynInfo synInfo = new SynInfo(true);
 session.push(synInfo, new Stream.FrameListener.Adapter()
 {
     public void onReply(Stream stream, ReplyInfo replyInfo)
     {
         // Stream reply received
     }
 });
 

A Session is the active part of the endpoint, and by calling its API applications can generate events on the connection; conversely SessionFrameListener is the passive part of the endpoint, and has callbacks that are invoked when events happen on the connection.

See Also:

SessionFrameListener

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Session.Listener Super interface for listeners with callbacks that are invoked on specific session events.
static interface	Session.StreamListener Specialized listener that is invoked upon creation and removal of streams.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(Session.Listener listener) Registers the given listener to be notified of session events.
Object	getAttribute(String key)
InetSocketAddress	getLocalAddress()
InetSocketAddress	getRemoteAddress()
Stream	getStream(int streamId)
Set<Stream>	getStreams()
short	getVersion()
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.
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.
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.

Method Detail

getVersion

short getVersion()

Returns:

the SPDY protocol version used by this session

addListener

void addListener(Session.Listener listener)

Registers the given listener to be notified of session events.

Parameters:

listener - the listener to register

See Also:

removeListener(Listener)

removeListener

void removeListener(Session.Listener listener)

Deregisters the give listener from being notified of session events.

Parameters:

listener - the listener to deregister

See Also:

addListener(Listener)

syn

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

Sends a SYN_FRAME to create a new SPDY stream.

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

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:

syn(SynInfo, StreamFrameListener, Promise)

syn

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

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.

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:

syn(SynInfo, StreamFrameListener)

rst

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

Sends synchronously a RST_STREAM to abort a stream.

Parameters:

rstInfo - the metadata to reset the stream

Throws:

InterruptedException

ExecutionException

TimeoutException

See Also:

rst(RstInfo, Callback)

rst

void rst(RstInfo rstInfo,
       Callback callback)

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.

Parameters:

rstInfo - the metadata to reset the stream

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

See Also:

rst(RstInfo)

settings

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

Sends synchronously a SETTINGS to configure the SPDY connection.

Parameters:

settingsInfo - the metadata to send

Throws:

ExecutionException

InterruptedException

TimeoutException

See Also:

settings(SettingsInfo, Callback)

settings

void settings(SettingsInfo settingsInfo,
            Callback callback)

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.

Parameters:

settingsInfo - the metadata to send

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

See Also:

settings(SettingsInfo)

ping

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

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

Parameters:

pingInfo -

Throws:

ExecutionException

InterruptedException

TimeoutException

See Also:

ping(PingInfo, Promise)

ping

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

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.

Parameters:

pingInfo -

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

See Also:

ping(PingInfo)

goAway

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

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

Parameters:

goAwayInfo -

Throws:

ExecutionException

InterruptedException

TimeoutException

See Also:

goAway(GoAwayInfo, Callback)

goAway

void goAway(GoAwayInfo goAwayInfo,
          Callback callback)

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.

Parameters:

goAwayInfo -

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

See Also:

goAway(GoAwayInfo)

getStreams

Set<Stream> getStreams()

Returns:

a snapshot of the streams currently active in this session

See Also:

getStream(int)

getStream

Stream getStream(int streamId)

Parameters:

streamId - the id of the stream to retrieve

Returns:

the stream with the given stream id

See Also:

getStreams()

getAttribute

Object getAttribute(String key)

Parameters:

key - the attribute key

Returns:

an arbitrary object associated with the given key to this session

See Also:

setAttribute(String, Object)

setAttribute

void setAttribute(String key,
                Object value)

Parameters:

key - the attribute key

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

See Also:

getAttribute(String), removeAttribute(String)

removeAttribute

Object removeAttribute(String key)

Parameters:

key - the attribute key

Returns:

the arbitrary object associated with the given key to this session

See Also:

setAttribute(String, Object)

getLocalAddress

InetSocketAddress getLocalAddress()

Returns:

the local address of the underlying endpoint

getRemoteAddress

InetSocketAddress getRemoteAddress()

Returns:

the remote address of the underlying endpoint