Class SpdyFrameCodec

io.netty.handler.codec.spdy.SpdyFrameCodec

All Implemented Interfaces:: ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler, SpdyFrameDecoderDelegate

public class SpdyFrameCodec extends ByteToMessageDecoder implements SpdyFrameDecoderDelegate, ChannelOutboundHandler

A ChannelHandler that encodes and decodes SPDY Frames.

Nested Class Summary

Nested classes/interfaces inherited from class ByteToMessageDecoder
ByteToMessageDecoder.Cumulator

Nested classes/interfaces inherited from interface ChannelHandler
ChannelHandler.Sharable
Field Summary

Fields

Modifier and Type

Field

Description

protected static final SpdyProtocolException

INVALID_FRAME

protected final SpdyFrameDecoder

spdyFrameDecoder

protected final SpdyFrameEncoder

spdyFrameEncoder

Fields inherited from class ByteToMessageDecoder
COMPOSITE_CUMULATOR, MERGE_CUMULATOR
Constructor Summary

Constructors

Modifier

Constructor

Description

SpdyFrameCodec (SpdyVersion version)

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

SpdyFrameCodec (SpdyVersion version, boolean validateHeaders)

Creates a new instance with the specified version, validateHeaders, 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 version, validateHeaders (true), decoder and encoder options.

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

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

SpdyFrameCodec (SpdyVersion version, int maxChunkSize, int maxHeaderSize, int compressionLevel, int windowBits, int memLevel, boolean validateHeaders, boolean supportsUnknownFrames)

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

protected

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

protected

SpdyFrameCodec (SpdyVersion version, int maxChunkSize, SpdyHeaderBlockDecoder spdyHeaderBlockDecoder, SpdyHeaderBlockEncoder spdyHeaderBlockEncoder, boolean validateHeaders, boolean supportsUnknownFrames)
Method Summary

Modifier and Type

Method

Description

void

bind (ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise)

Called once a bind operation is made.

void

channelReadComplete (ChannelHandlerContext ctx)

Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline.

void

close (ChannelHandlerContext ctx, ChannelPromise promise)

Called once a close operation is made.

void

connect (ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)

Called once a connect operation is made.

protected SpdyFrameDecoder

createDecoder (SpdyVersion version, SpdyFrameDecoderDelegate delegate, int maxChunkSize)

protected SpdyFrameEncoder

createEncoder (SpdyVersion version)

protected void

decode (ChannelHandlerContext ctx, ByteBuf in, List<Object> out)

Decode the from one ByteBuf to an other.

void

deregister (ChannelHandlerContext ctx, ChannelPromise promise)

Called once a deregister operation is made from the current registered EventLoop.

void

disconnect (ChannelHandlerContext ctx, ChannelPromise promise)

Called once a disconnect operation is made.

void

flush (ChannelHandlerContext ctx)

Called once a flush operation is made.

void

handlerAdded (ChannelHandlerContext ctx)

Do nothing by default, sub-classes may override this method.

protected boolean

isValidUnknownFrameHeader (int streamId, int type, byte flags, int length)

Check whether the unknown frame is valid, if not, the frame will be discarded, otherwise, the frame will be passed to SpdyFrameDecoder.decodeUnknownFrame(int, byte, int, ByteBuf).

protected SpdyFrame

newSpdyUnknownFrame (int frameType, byte flags, ByteBuf payload)

Create a SpdyUnknownFrame.

void

read (ChannelHandlerContext ctx)

Intercepts ChannelHandlerContext.read().

void

readDataFrame (int streamId, boolean last, 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 (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

readUnknownFrame (int frameType, byte flags, ByteBuf payload)

Called when an unknown frame is received.

void

readWindowUpdateFrame (int streamId, int deltaWindowSize)

Called when a WINDOW_UPDATE frame is received.

void

write (ChannelHandlerContext ctx, Object msg, ChannelPromise promise)

Called once a write operation is made.

Methods inherited from class ByteToMessageDecoder
actualReadableBytes, callDecode, channelInactive, channelRead, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

Methods inherited from class ChannelInboundHandlerAdapter
channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Methods inherited from class ChannelHandlerAdapter
ensureNotSharable, isSharable

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ChannelHandler
handlerRemoved

Field Details
- INVALID_FRAME
  
  protected static final SpdyProtocolException INVALID_FRAME
- spdyFrameDecoder
  
  protected final SpdyFrameDecoder spdyFrameDecoder
- spdyFrameEncoder
  
  protected final SpdyFrameEncoder spdyFrameEncoder
Constructor Details
- SpdyFrameCodec
  
  public SpdyFrameCodec(SpdyVersion version)
  
  Creates a new instance with the specified version, validateHeaders (true), and the default decoder and encoder options (maxChunkSize (8192), maxHeaderSize (16384), compressionLevel (6), windowBits (15), and memLevel (8)).
- SpdyFrameCodec
  
  public SpdyFrameCodec(SpdyVersion version, boolean validateHeaders)
  
  Creates a new instance with the specified version, validateHeaders, 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 version, validateHeaders (true), decoder and encoder options.
- SpdyFrameCodec
  
  public SpdyFrameCodec(SpdyVersion version, int maxChunkSize, int maxHeaderSize, int compressionLevel, int windowBits, int memLevel, boolean validateHeaders)
  
  Creates a new instance with the specified version, validateHeaders, decoder and encoder options.
- SpdyFrameCodec
  
  public SpdyFrameCodec(SpdyVersion version, int maxChunkSize, int maxHeaderSize, int compressionLevel, int windowBits, int memLevel, boolean validateHeaders, boolean supportsUnknownFrames)
  
  Creates a new instance with the specified version, validateHeaders, decoder and encoder options.
- SpdyFrameCodec
  
  protected SpdyFrameCodec(SpdyVersion version, int maxChunkSize, SpdyHeaderBlockDecoder spdyHeaderBlockDecoder, SpdyHeaderBlockEncoder spdyHeaderBlockEncoder, boolean validateHeaders)
- SpdyFrameCodec
  
  protected SpdyFrameCodec(SpdyVersion version, int maxChunkSize, SpdyHeaderBlockDecoder spdyHeaderBlockDecoder, SpdyHeaderBlockEncoder spdyHeaderBlockEncoder, boolean validateHeaders, boolean supportsUnknownFrames)
Method Details
- createDecoder
  
  protected SpdyFrameDecoder createDecoder(SpdyVersion version, SpdyFrameDecoderDelegate delegate, int maxChunkSize)
- createEncoder
  
  protected SpdyFrameEncoder createEncoder(SpdyVersion version)
- handlerAdded
  
  public void handlerAdded(ChannelHandlerContext ctx) throws Exception
  
  Description copied from class: ChannelHandlerAdapter
  
  Do nothing by default, sub-classes may override this method.
  
  Specified by:
  
  handlerAdded in interface ChannelHandler
  
  Overrides:
  
  handlerAdded in class ChannelHandlerAdapter
  
  Throws:
  
  Exception
- decode
  
  protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception
  
  Description copied from class: ByteToMessageDecoder
  
  Decode the from one ByteBuf to an other. This method will be called till either the input ByteBuf has nothing to read when return from this method or till nothing was read from the input ByteBuf.
  
  Specified by:
  
  decode in class ByteToMessageDecoder
  
  Parameters:
  
  ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to
  
  in - the ByteBuf from which to read data
  
  out - the List to which decoded messages should be added
  
  Throws:
  
  Exception - is thrown if an error occurs
- channelReadComplete
  
  public void channelReadComplete(ChannelHandlerContext ctx) throws Exception
  
  Description copied from class: ChannelInboundHandlerAdapter
  
  Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.
  
  Specified by:
  
  channelReadComplete in interface ChannelInboundHandler
  
  Overrides:
  
  channelReadComplete in class ByteToMessageDecoder
  
  Throws:
  
  Exception
- bind
  
  public void bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise) throws Exception
  
  Description copied from interface: ChannelOutboundHandler
  
  Called once a bind operation is made.
  
  Specified by:
  
  bind in interface ChannelOutboundHandler
  
  Parameters:
  
  ctx - the ChannelHandlerContext for which the bind operation is made
  
  localAddress - the SocketAddress to which it should bound
  
  promise - the ChannelPromise to notify once the operation completes
  
  Throws:
  
  Exception - thrown if an error occurs
- connect
  
  public void connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise) throws Exception
  
  Description copied from interface: ChannelOutboundHandler
  
  Called once a connect operation is made.
  
  Specified by:
  
  connect in interface ChannelOutboundHandler
  
  Parameters:
  
  ctx - the ChannelHandlerContext for which the connect operation is made
  
  remoteAddress - the SocketAddress to which it should connect
  
  localAddress - the SocketAddress which is used as source on connect
  
  promise - the ChannelPromise to notify once the operation completes
  
  Throws:
  
  Exception - thrown if an error occurs
- disconnect
  
  public void disconnect(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception
  
  Description copied from interface: ChannelOutboundHandler
  
  Called once a disconnect operation is made.
  
  Specified by:
  
  disconnect in interface ChannelOutboundHandler
  
  Parameters:
  
  ctx - the ChannelHandlerContext for which the disconnect operation is made
  
  promise - the ChannelPromise to notify once the operation completes
  
  Throws:
  
  Exception - thrown if an error occurs
- close
  
  public void close(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception
  
  Description copied from interface: ChannelOutboundHandler
  
  Called once a close operation is made.
  
  Specified by:
  
  close in interface ChannelOutboundHandler
  
  Parameters:
  
  ctx - the ChannelHandlerContext for which the close operation is made
  
  promise - the ChannelPromise to notify once the operation completes
  
  Throws:
  
  Exception - thrown if an error occurs
- deregister
  
  public void deregister(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception
  
  Description copied from interface: ChannelOutboundHandler
  
  Called once a deregister operation is made from the current registered EventLoop.
  
  Specified by:
  
  deregister in interface ChannelOutboundHandler
  
  Parameters:
  
  ctx - the ChannelHandlerContext for which the close operation is made
  
  promise - the ChannelPromise to notify once the operation completes
  
  Throws:
  
  Exception - thrown if an error occurs
- read
  
  public void read(ChannelHandlerContext ctx) throws Exception
  
  Description copied from interface: ChannelOutboundHandler
  
  Intercepts ChannelHandlerContext.read().
  
  Specified by:
  
  read in interface ChannelOutboundHandler
  
  Throws:
  
  Exception
- flush
  
  public void flush(ChannelHandlerContext ctx) throws Exception
  
  Description copied from interface: ChannelOutboundHandler
  
  Called once a flush operation is made. The flush operation will try to flush out all previous written messages that are pending.
  
  Specified by:
  
  flush in interface ChannelOutboundHandler
  
  Parameters:
  
  ctx - the ChannelHandlerContext for which the flush operation is made
  
  Throws:
  
  Exception - thrown if an error occurs
- write
  
  public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception
  
  Description copied from interface: ChannelOutboundHandler
  
  Called once a write operation is made. The write operation will write the messages through the ChannelPipeline. Those are then ready to be flushed to the actual Channel once Channel.flush() is called
  
  Specified by:
  
  write in interface ChannelOutboundHandler
  
  Parameters:
  
  ctx - the ChannelHandlerContext for which the write operation is made
  
  msg - the message to write
  
  promise - the ChannelPromise to notify once the operation completes
  
  Throws:
  
  Exception - thrown if an error occurs
- readDataFrame
  
  public void readDataFrame(int streamId, boolean last, 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(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
- readUnknownFrame
  
  public void readUnknownFrame(int frameType, byte flags, ByteBuf payload)
  
  Description copied from interface: SpdyFrameDecoderDelegate
  
  Called when an unknown frame is received.
  
  Specified by:
  
  readUnknownFrame in interface SpdyFrameDecoderDelegate
  
  Parameters:
  
  frameType - the frame type from the spdy header.
  
  flags - the flags in the frame header.
  
  payload - the payload of the frame.
- newSpdyUnknownFrame
  
  protected SpdyFrame newSpdyUnknownFrame(int frameType, byte flags, ByteBuf payload)
  
  Create a SpdyUnknownFrame.
- isValidUnknownFrameHeader
  
  protected boolean isValidUnknownFrameHeader(int streamId, int type, byte flags, int length)
  
  Check whether the unknown frame is valid, if not, the frame will be discarded, otherwise, the frame will be passed to SpdyFrameDecoder.decodeUnknownFrame(int, byte, int, ByteBuf).
  By default this method always returns false, sub-classes may override this.
- 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

Class SpdyFrameCodec

Nested Class Summary

Nested classes/interfaces inherited from class ByteToMessageDecoder

Nested classes/interfaces inherited from interface ChannelHandler

Field Summary

Fields inherited from class ByteToMessageDecoder

Constructor Summary

Method Summary

Methods inherited from class ByteToMessageDecoder

Methods inherited from class ChannelInboundHandlerAdapter

Methods inherited from class ChannelHandlerAdapter

Methods inherited from class Object

Methods inherited from interface ChannelHandler

Field Details

INVALID_FRAME

spdyFrameDecoder

spdyFrameEncoder

Constructor Details

SpdyFrameCodec

SpdyFrameCodec

SpdyFrameCodec

SpdyFrameCodec

SpdyFrameCodec

SpdyFrameCodec

SpdyFrameCodec

Method Details

createDecoder

createEncoder

handlerAdded

decode

channelReadComplete

bind

connect

disconnect

close

deregister

read

flush

write

readDataFrame

readSynStreamFrame

readSynReplyFrame

readRstStreamFrame

readSettingsFrame

readSetting

readSettingsEnd

readPingFrame

readGoAwayFrame

readHeadersFrame

readWindowUpdateFrame

readHeaderBlock

readHeaderBlockEnd

readUnknownFrame

newSpdyUnknownFrame

isValidUnknownFrameHeader

readFrameError