org.eclipse.jetty.spdy.api

Class SessionFrameListener.Adapter

java.lang.Object

org.eclipse.jetty.spdy.api.SessionFrameListener.Adapter

All Implemented Interfaces:

EventListener, SessionFrameListener

Direct Known Subclasses:

ServerSessionFrameListener.Adapter

Enclosing interface:

SessionFrameListener

public static class SessionFrameListener.Adapter
extends Object
implements SessionFrameListener

Empty implementation of SessionFrameListener

Nested Class Summary

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

SessionFrameListener.Adapter

Constructor Summary

Constructors

Constructor and Description
SessionFrameListener.Adapter()

Method Summary

Methods

Modifier and Type	Method and Description
void	onFailure(Session session, Throwable x) Callback invoked when an exception is thrown during the processing of an event on a SPDY session.
void	onGoAway(Session session, GoAwayResultInfo goAwayResultInfo) Callback invoked when the other peer signals that it is closing the connection.
void	onPing(Session session, PingResultInfo pingResultInfo) Callback invoked when a ping request has completed its round-trip.
void	onRst(Session session, RstInfo rstInfo) Callback invoked when a stream error happens.
void	onSettings(Session session, SettingsInfo settingsInfo) Callback invoked when a request to configure the SPDY connection has been received.
StreamFrameListener	onSyn(Stream stream, SynInfo synInfo) Callback invoked when a request to create a stream has been received.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionFrameListener.Adapter

public SessionFrameListener.Adapter()

Method Detail

onSyn

public StreamFrameListener onSyn(Stream stream,
                        SynInfo synInfo)

Description copied from interface: SessionFrameListener

Callback invoked when a request to create a stream has been received.

Application code should implement this method and reply to the stream creation, eventually sending data:

 public StreamFrameListener onSyn(Stream stream, SynInfo synInfo)
 {
     // Do something with the metadata contained in synInfo

     if (stream.isHalfClosed()) // The other peer will not send data
     {
         stream.reply(new ReplyInfo(false));
         stream.data(new StringDataInfo("foo", true));
         return null; // Not interested in further stream events
     }

     ...
 }
 

Alternatively, if the stream creation requires reading data sent from the other peer:

 public StreamFrameListener onSyn(Stream stream, SynInfo synInfo)
 {
     // Do something with the metadata contained in synInfo

     if (!stream.isHalfClosed()) // The other peer will send data
     {
         stream.reply(new ReplyInfo(true));
         return new Stream.FrameListener.Adapter() // Interested in stream events
         {
             public void onData(Stream stream, DataInfo dataInfo)
             {
                 // Do something with the incoming data in dataInfo
             }
         };
     }

     ...
 }
 

Specified by:

onSyn in interface SessionFrameListener

Parameters:

stream - the stream just created

synInfo - the metadata sent on stream creation

Returns:

a listener for stream events, or null if there is no interest in being notified of stream events

onRst

public void onRst(Session session,
         RstInfo rstInfo)

Description copied from interface: SessionFrameListener

Callback invoked when a stream error happens.

Specified by:

onRst in interface SessionFrameListener

Parameters:

session - the session

rstInfo - the metadata of the stream error

onSettings

public void onSettings(Session session,
              SettingsInfo settingsInfo)

Description copied from interface: SessionFrameListener

Callback invoked when a request to configure the SPDY connection has been received.

Specified by:

onSettings in interface SessionFrameListener

Parameters:

session - the session

settingsInfo - the metadata sent to configure

onPing

public void onPing(Session session,
          PingResultInfo pingResultInfo)

Description copied from interface: SessionFrameListener

Callback invoked when a ping request has completed its round-trip.

Specified by:

onPing in interface SessionFrameListener

Parameters:

session - the session

pingResultInfo - the metadata received

onGoAway

public void onGoAway(Session session,
            GoAwayResultInfo goAwayResultInfo)

Description copied from interface: SessionFrameListener

Callback invoked when the other peer signals that it is closing the connection.

Specified by:

onGoAway in interface SessionFrameListener

Parameters:

session - the session

goAwayResultInfo - the metadata sent

onFailure

public void onFailure(Session session,
             Throwable x)

Description copied from interface: SessionFrameListener

Callback invoked when an exception is thrown during the processing of an event on a SPDY session.

Examples of such conditions are invalid frames received, corrupted headers compression state, etc.

Specified by:

onFailure in interface SessionFrameListener

Parameters:

session - the session

x - the exception that caused the event processing failure