org.jboss.netty.handler.codec.spdy

Class SpdyFrameCodec

java.lang.Object

org.jboss.netty.channel.SimpleChannelUpstreamHandler

org.jboss.netty.handler.codec.frame.FrameDecoder

org.jboss.netty.handler.codec.spdy.SpdyFrameCodec

All Implemented Interfaces:

ChannelDownstreamHandler, ChannelHandler, ChannelUpstreamHandler, LifeCycleAwareChannelHandler, SpdyFrameDecoderDelegate

public class SpdyFrameCodec
extends FrameDecoder
implements SpdyFrameDecoderDelegate, ChannelDownstreamHandler

A ChannelHandler that encodes and decodes SPDY Frames.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
private ChannelHandlerContext	ctx
private static SpdyProtocolException	INVALID_FRAME
private SpdyFrameDecoder	spdyFrameDecoder
private SpdyFrameEncoder	spdyFrameEncoder
private SpdyHeaderBlockDecoder	spdyHeaderBlockDecoder
private SpdyHeaderBlockEncoder	spdyHeaderBlockEncoder
private SpdyHeadersFrame	spdyHeadersFrame
private SpdySettingsFrame	spdySettingsFrame

Fields inherited from class org.jboss.netty.handler.codec.frame.FrameDecoder

cumulation, DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS

Constructor Summary

Constructors

Modifier	Constructor and Description
	SpdyFrameCodec(SpdyVersion version) Creates a new instance with the specified version and the default decoder and encoder options (maxChunkSize (8192), maxHeaderSize (16384), compressionLevel (6), windowBits (15), and memLevel (8)).
	SpdyFrameCodec(SpdyVersion version, int maxChunkSize, int maxHeaderSize, int compressionLevel, int windowBits, int memLevel) Creates a new instance with the specified decoder and encoder options.
protected	SpdyFrameCodec(SpdyVersion version, int maxChunkSize, SpdyHeaderBlockDecoder spdyHeaderBlockDecoder, SpdyHeaderBlockEncoder spdyHeaderBlockEncoder)

Method Summary

Modifier and Type	Method and Description
void	beforeAdd(ChannelHandlerContext ctx)
protected void	cleanup(ChannelHandlerContext ctx, ChannelStateEvent e) Gets called on FrameDecoder.channelDisconnected(ChannelHandlerContext, ChannelStateEvent) and FrameDecoder.channelClosed(ChannelHandlerContext, ChannelStateEvent)
protected java.lang.Object	decode(ChannelHandlerContext ctx, Channel channel, ChannelBuffer buffer) Decodes the received packets so far into a frame.
void	handleDownstream(ChannelHandlerContext ctx, ChannelEvent evt) Handles the specified downstream event.
void	readDataFrame(int streamId, boolean last, ChannelBuffer data) Called when a DATA frame is received.
void	readFrameError(java.lang.String message) Called when an unrecoverable session error has occurred.
void	readGoAwayFrame(int lastGoodStreamId, int statusCode) Called when a GOAWAY frame is received.
void	readHeaderBlock(ChannelBuffer headerBlock) Called when the header block within a SYN_STREAM, SYN_REPLY, or HEADERS frame is received.
void	readHeaderBlockEnd() Called when an entire header block has been received.
void	readHeadersFrame(int streamId, boolean last) Called when a HEADERS frame is received.
void	readPingFrame(int id) Called when a PING frame is received.
void	readRstStreamFrame(int streamId, int statusCode) Called when a RST_STREAM frame is received.
void	readSetting(int id, int value, boolean persistValue, boolean persisted) Called when an individual setting within a SETTINGS frame is received.
void	readSettingsEnd() Called when the entire SETTINGS frame has been received.
void	readSettingsFrame(boolean clearPersisted) Called when a SETTINGS frame is received.
void	readSynReplyFrame(int streamId, boolean last) Called when a SYN_REPLY frame is received.
void	readSynStreamFrame(int streamId, int associatedToStreamId, byte priority, boolean last, boolean unidirectional) Called when a SYN_STREAM frame is received.
void	readWindowUpdateFrame(int streamId, int deltaWindowSize) Called when a WINDOW_UPDATE frame is received.

Methods inherited from class org.jboss.netty.handler.codec.frame.FrameDecoder

actualReadableBytes, afterAdd, afterRemove, appendToCumulation, beforeRemove, channelClosed, channelDisconnected, decodeLast, exceptionCaught, extractFrame, getMaxCumulationBufferCapacity, getMaxCumulationBufferComponents, internalBuffer, isUnfold, messageReceived, newCumulationBuffer, replace, setMaxCumulationBufferCapacity, setMaxCumulationBufferComponents, setUnfold, unfoldAndFireMessageReceived, updateCumulation

Methods inherited from class org.jboss.netty.channel.SimpleChannelUpstreamHandler

channelBound, channelConnected, channelInterestChanged, channelOpen, channelUnbound, childChannelClosed, childChannelOpen, handleUpstream, writeComplete

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_FRAME

private static final SpdyProtocolException INVALID_FRAME

spdyFrameDecoder

private final SpdyFrameDecoder spdyFrameDecoder

spdyFrameEncoder

private final SpdyFrameEncoder spdyFrameEncoder

spdyHeaderBlockDecoder

private final SpdyHeaderBlockDecoder spdyHeaderBlockDecoder

spdyHeaderBlockEncoder

private final SpdyHeaderBlockEncoder spdyHeaderBlockEncoder

spdyHeadersFrame

private SpdyHeadersFrame spdyHeadersFrame

spdySettingsFrame

private SpdySettingsFrame spdySettingsFrame

ctx

private volatile ChannelHandlerContext ctx

Constructor Detail

SpdyFrameCodec

public SpdyFrameCodec(SpdyVersion version)

Creates a new instance with the specified version and the default decoder and encoder options (maxChunkSize (8192), maxHeaderSize (16384), compressionLevel (6), windowBits (15), and memLevel (8)).

SpdyFrameCodec

public SpdyFrameCodec(SpdyVersion version,
                      int maxChunkSize,
                      int maxHeaderSize,
                      int compressionLevel,
                      int windowBits,
                      int memLevel)

Creates a new instance with the specified decoder and encoder options.

SpdyFrameCodec

protected SpdyFrameCodec(SpdyVersion version,
                         int maxChunkSize,
                         SpdyHeaderBlockDecoder spdyHeaderBlockDecoder,
                         SpdyHeaderBlockEncoder spdyHeaderBlockEncoder)

Method Detail

beforeAdd

public void beforeAdd(ChannelHandlerContext ctx)
               throws java.lang.Exception

Specified by:

beforeAdd in interface LifeCycleAwareChannelHandler

Overrides:

beforeAdd in class FrameDecoder

Throws:

java.lang.Exception

decode

protected java.lang.Object decode(ChannelHandlerContext ctx,
                                  Channel channel,
                                  ChannelBuffer buffer)
                           throws java.lang.Exception

Description copied from class: FrameDecoder

Decodes the received packets so far into a frame. If an sub-class wants to extract a frame out of the buffer it should use the FrameDecoder.extractFrame(ChannelBuffer, int, int) method, to make optimizations easier later.

Specified by:

decode in class FrameDecoder

Parameters:

ctx - the context of this handler

channel - the current channel

buffer - the cumulative buffer of received packets so far. Note that the buffer might be empty, which means you should not make an assumption that the buffer contains at least one byte in your decoder implementation.

Returns:

the decoded frame if a full frame was received and decoded. null if there's not enough data in the buffer to decode a frame.

Throws:

java.lang.Exception

cleanup

protected void cleanup(ChannelHandlerContext ctx,
                       ChannelStateEvent e)
                throws java.lang.Exception

Description copied from class: FrameDecoder

Gets called on FrameDecoder.channelDisconnected(ChannelHandlerContext, ChannelStateEvent) and FrameDecoder.channelClosed(ChannelHandlerContext, ChannelStateEvent)

Overrides:

cleanup in class FrameDecoder

Throws:

java.lang.Exception

handleDownstream

public void handleDownstream(ChannelHandlerContext ctx,
                             ChannelEvent evt)
                      throws java.lang.Exception

Description copied from interface: ChannelDownstreamHandler

Handles the specified downstream event.

Specified by:

handleDownstream in interface ChannelDownstreamHandler

Parameters:

ctx - the context object for this handler

evt - the downstream event to process or intercept

Throws:

java.lang.Exception

readDataFrame

public void readDataFrame(int streamId,
                          boolean last,
                          ChannelBuffer data)

Description copied from interface: SpdyFrameDecoderDelegate

Called when a DATA frame is received.

Specified by:

readDataFrame in interface SpdyFrameDecoderDelegate

readSynStreamFrame

public void readSynStreamFrame(int streamId,
                               int associatedToStreamId,
                               byte priority,
                               boolean last,
                               boolean unidirectional)

Description copied from interface: SpdyFrameDecoderDelegate

Called when a SYN_STREAM frame is received. The Name/Value Header Block is not included. See readHeaderBlock().

Specified by:

readSynStreamFrame in interface SpdyFrameDecoderDelegate

readSynReplyFrame

public void readSynReplyFrame(int streamId,
                              boolean last)

Description copied from interface: SpdyFrameDecoderDelegate

Called when a SYN_REPLY frame is received. The Name/Value Header Block is not included. See readHeaderBlock().

Specified by:

readSynReplyFrame in interface SpdyFrameDecoderDelegate

readRstStreamFrame

public void readRstStreamFrame(int streamId,
                               int statusCode)

Description copied from interface: SpdyFrameDecoderDelegate

Called when a RST_STREAM frame is received.

Specified by:

readRstStreamFrame in interface SpdyFrameDecoderDelegate

readSettingsFrame

public void readSettingsFrame(boolean clearPersisted)

Description copied from interface: SpdyFrameDecoderDelegate

Called when a SETTINGS frame is received. Settings are not included. See readSetting().

Specified by:

readSettingsFrame in interface SpdyFrameDecoderDelegate

readSetting

public void readSetting(int id,
                        int value,
                        boolean persistValue,
                        boolean persisted)

Description copied from interface: SpdyFrameDecoderDelegate

Called when an individual setting within a SETTINGS frame is received.

Specified by:

readSetting in interface SpdyFrameDecoderDelegate

readSettingsEnd

public void readSettingsEnd()

Description copied from interface: SpdyFrameDecoderDelegate

Called when the entire SETTINGS frame has been received.

Specified by:

readSettingsEnd in interface SpdyFrameDecoderDelegate

readPingFrame

public void readPingFrame(int id)

Description copied from interface: SpdyFrameDecoderDelegate

Called when a PING frame is received.

Specified by:

readPingFrame in interface SpdyFrameDecoderDelegate

readGoAwayFrame

public void readGoAwayFrame(int lastGoodStreamId,
                            int statusCode)

Description copied from interface: SpdyFrameDecoderDelegate

Called when a GOAWAY frame is received.

Specified by:

readGoAwayFrame in interface SpdyFrameDecoderDelegate

readHeadersFrame

public void readHeadersFrame(int streamId,
                             boolean last)

Description copied from interface: SpdyFrameDecoderDelegate

Called when a HEADERS frame is received. The Name/Value Header Block is not included. See readHeaderBlock().

Specified by:

readHeadersFrame in interface SpdyFrameDecoderDelegate

readWindowUpdateFrame

public void readWindowUpdateFrame(int streamId,
                                  int deltaWindowSize)

Description copied from interface: SpdyFrameDecoderDelegate

Called when a WINDOW_UPDATE frame is received.

Specified by:

readWindowUpdateFrame in interface SpdyFrameDecoderDelegate

readHeaderBlock

public void readHeaderBlock(ChannelBuffer headerBlock)

Description copied from interface: SpdyFrameDecoderDelegate

Called when the header block within a SYN_STREAM, SYN_REPLY, or HEADERS frame is received.

Specified by:

readHeaderBlock in interface SpdyFrameDecoderDelegate

readHeaderBlockEnd

public void readHeaderBlockEnd()

Description copied from interface: SpdyFrameDecoderDelegate

Called when an entire header block has been received.

Specified by:

readHeaderBlockEnd in interface SpdyFrameDecoderDelegate

readFrameError

public void readFrameError(java.lang.String message)

Description copied from interface: SpdyFrameDecoderDelegate

Called when an unrecoverable session error has occurred.

Specified by:

readFrameError in interface SpdyFrameDecoderDelegate