io.netty.handler.codec.spdy

Class SpdyFrameCodec

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.spdy.SpdyFrameCodec

All Implemented Interfaces:

io.netty.channel.ChannelHandler, SpdyFrameDecoderDelegate

public class SpdyFrameCodec
extends io.netty.handler.codec.ByteToMessageDecoder
implements SpdyFrameDecoderDelegate

A ChannelHandler that encodes and decodes SPDY Frames.

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.ByteToMessageDecoder.Cumulator

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable, io.netty.channel.ChannelHandler.Skip

Field Summary

Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

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, io.netty.handler.codec.spdy.SpdyHeaderBlockDecoder spdyHeaderBlockDecoder, io.netty.handler.codec.spdy.SpdyHeaderBlockEncoder spdyHeaderBlockEncoder)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, List<Object> out)
void	handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
void	readDataFrame(int streamId, boolean last, io.netty.buffer.ByteBuf data) Called when a DATA frame is received.
void	readFrameError(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(io.netty.buffer.ByteBuf 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.
void	write(io.netty.channel.ChannelHandlerContext ctx, Object msg, io.netty.channel.ChannelPromise promise)

Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder

actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setSingleDecode

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

bind, channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, exceptionCaught, flush, isSharable, read, userEventTriggered

Methods inherited from class java.lang.Object

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

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,
              io.netty.handler.codec.spdy.SpdyHeaderBlockDecoder spdyHeaderBlockDecoder,
              io.netty.handler.codec.spdy.SpdyHeaderBlockEncoder spdyHeaderBlockEncoder)

Method Detail

handlerAdded

public void handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
                  throws Exception

Specified by:

handlerAdded in interface io.netty.channel.ChannelHandler

Overrides:

handlerAdded in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

decode

protected void decode(io.netty.channel.ChannelHandlerContext ctx,
          io.netty.buffer.ByteBuf in,
          List<Object> out)
               throws Exception

Specified by:

decode in class io.netty.handler.codec.ByteToMessageDecoder

Throws:

Exception

write

public void write(io.netty.channel.ChannelHandlerContext ctx,
         Object msg,
         io.netty.channel.ChannelPromise promise)
           throws Exception

Specified by:

write in interface io.netty.channel.ChannelHandler

Overrides:

write in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

readDataFrame

public void readDataFrame(int streamId,
                 boolean last,
                 io.netty.buffer.ByteBuf 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(io.netty.buffer.ByteBuf 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(String message)

Description copied from interface: SpdyFrameDecoderDelegate

Called when an unrecoverable session error has occurred.

Specified by:

readFrameError in interface SpdyFrameDecoderDelegate