SpdyFrameCodec (Netty 4.1.109.Final API文档

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelInboundHandlerAdapter
  - - io.netty.handler.codec.ByteToMessageDecoder
    - - io.netty.handler.codec.spdy.SpdyFrameCodec

所有已实现的接口:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler, SpdyFrameDecoderDelegate
```
public class SpdyFrameCodec
extends ByteToMessageDecoder
implements SpdyFrameDecoderDelegate, ChannelOutboundHandler
```
A ChannelHandler that encodes and decodes SPDY Frames.

嵌套类概要
- 从类继承的嵌套类/接口 io.netty.handler.codec.ByteToMessageDecoder
  ByteToMessageDecoder.Cumulator
- 从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler
  ChannelHandler.Sharable

字段概要
- 从类继承的字段 io.netty.handler.codec.ByteToMessageDecoder
  COMPOSITE_CUMULATOR, MERGE_CUMULATOR

构造器概要

构造器
限定符	构造器和说明
	`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.
`protected`	`SpdyFrameCodec(SpdyVersion version, int maxChunkSize, SpdyHeaderBlockDecoder spdyHeaderBlockDecoder, SpdyHeaderBlockEncoder spdyHeaderBlockEncoder, boolean validateHeaders)`

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`void`	`bind(ChannelHandlerContext ctx, java.net.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, java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise)` Called once a connect operation is made.
`protected void`	`decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.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.
`void`	`read(ChannelHandlerContext ctx)` Intercepts `ChannelHandlerContext.read()`.
`void`	`readDataFrame(int streamId, boolean last, ByteBuf 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(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(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise)` Called once a write operation is made.

从类继承的方法 io.netty.handler.codec.ByteToMessageDecoder
actualReadableBytes, callDecode, channelInactive, channelRead, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter
channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

从类继承的方法 io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, isSharable

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 io.netty.channel.ChannelHandler
exceptionCaught, handlerRemoved

- 构造器详细资料
  - 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
```
protected SpdyFrameCodec(SpdyVersion version,
                         int maxChunkSize,
                         SpdyHeaderBlockDecoder spdyHeaderBlockDecoder,
                         SpdyHeaderBlockEncoder spdyHeaderBlockEncoder,
                         boolean validateHeaders)
```
- 方法详细资料
  - handlerAdded
```
public void handlerAdded(ChannelHandlerContext ctx)
                  throws java.lang.Exception
```
    从类复制的说明: ChannelHandlerAdapter
    
    Do nothing by default, sub-classes may override this method.
    
    指定者:
    
    handlerAdded 在接口中 ChannelHandler
    
    覆盖:
    
    handlerAdded 在类中 ChannelHandlerAdapter
    
    抛出:
    
    java.lang.Exception
  - decode
```
protected void decode(ChannelHandlerContext ctx,
                      ByteBuf in,
                      java.util.List<java.lang.Object> out)
               throws java.lang.Exception
```
    从类复制的说明: 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.
    
    指定者:
    
    decode 在类中 ByteToMessageDecoder
    
    参数:
    
    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
    
    抛出:
    
    java.lang.Exception - is thrown if an error occurs
  - channelReadComplete
```
public void channelReadComplete(ChannelHandlerContext ctx)
                         throws java.lang.Exception
```
    从类复制的说明: ChannelInboundHandlerAdapter
    
    Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.
    
    指定者:
    
    channelReadComplete 在接口中 ChannelInboundHandler
    
    覆盖:
    
    channelReadComplete 在类中 ByteToMessageDecoder
    
    抛出:
    
    java.lang.Exception
  - bind
```
public void bind(ChannelHandlerContext ctx,
                 java.net.SocketAddress localAddress,
                 ChannelPromise promise)
          throws java.lang.Exception
```
    从接口复制的说明: ChannelOutboundHandler
    
    Called once a bind operation is made.
    
    指定者:
    
    bind 在接口中 ChannelOutboundHandler
    
    参数:
    
    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
    
    抛出:
    
    java.lang.Exception - thrown if an error occurs
  - connect
```
public void connect(ChannelHandlerContext ctx,
                    java.net.SocketAddress remoteAddress,
                    java.net.SocketAddress localAddress,
                    ChannelPromise promise)
             throws java.lang.Exception
```
    从接口复制的说明: ChannelOutboundHandler
    
    Called once a connect operation is made.
    
    指定者:
    
    connect 在接口中 ChannelOutboundHandler
    
    参数:
    
    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
    
    抛出:
    
    java.lang.Exception - thrown if an error occurs
  - disconnect
```
public void disconnect(ChannelHandlerContext ctx,
                       ChannelPromise promise)
                throws java.lang.Exception
```
    从接口复制的说明: ChannelOutboundHandler
    
    Called once a disconnect operation is made.
    
    指定者:
    
    disconnect 在接口中 ChannelOutboundHandler
    
    参数:
    
    ctx - the ChannelHandlerContext for which the disconnect operation is made
    
    promise - the ChannelPromise to notify once the operation completes
    
    抛出:
    
    java.lang.Exception - thrown if an error occurs
  - close
```
public void close(ChannelHandlerContext ctx,
                  ChannelPromise promise)
           throws java.lang.Exception
```
    从接口复制的说明: ChannelOutboundHandler
    
    Called once a close operation is made.
    
    指定者:
    
    close 在接口中 ChannelOutboundHandler
    
    参数:
    
    ctx - the ChannelHandlerContext for which the close operation is made
    
    promise - the ChannelPromise to notify once the operation completes
    
    抛出:
    
    java.lang.Exception - thrown if an error occurs
  - deregister
```
public void deregister(ChannelHandlerContext ctx,
                       ChannelPromise promise)
                throws java.lang.Exception
```
    从接口复制的说明: ChannelOutboundHandler
    
    Called once a deregister operation is made from the current registered EventLoop.
    
    指定者:
    
    deregister 在接口中 ChannelOutboundHandler
    
    参数:
    
    ctx - the ChannelHandlerContext for which the close operation is made
    
    promise - the ChannelPromise to notify once the operation completes
    
    抛出:
    
    java.lang.Exception - thrown if an error occurs
  - read
```
public void read(ChannelHandlerContext ctx)
          throws java.lang.Exception
```
    从接口复制的说明: ChannelOutboundHandler
    
    Intercepts ChannelHandlerContext.read().
    
    指定者:
    
    read 在接口中 ChannelOutboundHandler
    
    抛出:
    
    java.lang.Exception
  - flush
```
public void flush(ChannelHandlerContext ctx)
           throws java.lang.Exception
```
    从接口复制的说明: ChannelOutboundHandler
    
    Called once a flush operation is made. The flush operation will try to flush out all previous written messages that are pending.
    
    指定者:
    
    flush 在接口中 ChannelOutboundHandler
    
    参数:
    
    ctx - the ChannelHandlerContext for which the flush operation is made
    
    抛出:
    
    java.lang.Exception - thrown if an error occurs
  - write
```
public void write(ChannelHandlerContext ctx,
                  java.lang.Object msg,
                  ChannelPromise promise)
           throws java.lang.Exception
```
    从接口复制的说明: 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
    
    指定者:
    
    write 在接口中 ChannelOutboundHandler
    
    参数:
    
    ctx - the ChannelHandlerContext for which the write operation is made
    
    msg - the message to write
    
    promise - the ChannelPromise to notify once the operation completes
    
    抛出:
    
    java.lang.Exception - thrown if an error occurs
  - readDataFrame
```
public void readDataFrame(int streamId,
                          boolean last,
                          ByteBuf data)
```
    从接口复制的说明: SpdyFrameDecoderDelegate
    
    Called when a DATA frame is received.
    
    指定者:
    
    readDataFrame 在接口中 SpdyFrameDecoderDelegate
  - readSynStreamFrame
```
public void readSynStreamFrame(int streamId,
                               int associatedToStreamId,
                               byte priority,
                               boolean last,
                               boolean unidirectional)
```
    从接口复制的说明: SpdyFrameDecoderDelegate
    
    Called when a SYN_STREAM frame is received. The Name/Value Header Block is not included. See readHeaderBlock().
    
    指定者:
    
    readSynStreamFrame 在接口中 SpdyFrameDecoderDelegate
  - readSynReplyFrame
```
public void readSynReplyFrame(int streamId,
                              boolean last)
```
    从接口复制的说明: SpdyFrameDecoderDelegate
    
    Called when a SYN_REPLY frame is received. The Name/Value Header Block is not included. See readHeaderBlock().
    
    指定者:
    
    readSynReplyFrame 在接口中 SpdyFrameDecoderDelegate
  - readRstStreamFrame
```
public void readRstStreamFrame(int streamId,
                               int statusCode)
```
    从接口复制的说明: SpdyFrameDecoderDelegate
    
    Called when a RST_STREAM frame is received.
    
    指定者:
    
    readRstStreamFrame 在接口中 SpdyFrameDecoderDelegate
  - readSettingsFrame
```
public void readSettingsFrame(boolean clearPersisted)
```
    从接口复制的说明: SpdyFrameDecoderDelegate
    
    Called when a SETTINGS frame is received. Settings are not included. See readSetting().
    
    指定者:
    
    readSettingsFrame 在接口中 SpdyFrameDecoderDelegate
  - readSetting
```
public void readSetting(int id,
                        int value,
                        boolean persistValue,
                        boolean persisted)
```
    从接口复制的说明: SpdyFrameDecoderDelegate
    
    Called when an individual setting within a SETTINGS frame is received.
    
    指定者:
    
    readSetting 在接口中 SpdyFrameDecoderDelegate
  - readSettingsEnd
```
public void readSettingsEnd()
```
    从接口复制的说明: SpdyFrameDecoderDelegate
    
    Called when the entire SETTINGS frame has been received.
    
    指定者:
    
    readSettingsEnd 在接口中 SpdyFrameDecoderDelegate
  - readPingFrame
```
public void readPingFrame(int id)
```
    从接口复制的说明: SpdyFrameDecoderDelegate
    
    Called when a PING frame is received.
    
    指定者:
    
    readPingFrame 在接口中 SpdyFrameDecoderDelegate
  - readGoAwayFrame
```
public void readGoAwayFrame(int lastGoodStreamId,
                            int statusCode)
```
    从接口复制的说明: SpdyFrameDecoderDelegate
    
    Called when a GOAWAY frame is received.
    
    指定者:
    
    readGoAwayFrame 在接口中 SpdyFrameDecoderDelegate
  - readHeadersFrame
```
public void readHeadersFrame(int streamId,
                             boolean last)
```
    从接口复制的说明: SpdyFrameDecoderDelegate
    
    Called when a HEADERS frame is received. The Name/Value Header Block is not included. See readHeaderBlock().
    
    指定者:
    
    readHeadersFrame 在接口中 SpdyFrameDecoderDelegate
  - readWindowUpdateFrame
```
public void readWindowUpdateFrame(int streamId,
                                  int deltaWindowSize)
```
    从接口复制的说明: SpdyFrameDecoderDelegate
    
    Called when a WINDOW_UPDATE frame is received.
    
    指定者:
    
    readWindowUpdateFrame 在接口中 SpdyFrameDecoderDelegate
  - readHeaderBlock
```
public void readHeaderBlock(ByteBuf headerBlock)
```
    从接口复制的说明: SpdyFrameDecoderDelegate
    
    Called when the header block within a SYN_STREAM, SYN_REPLY, or HEADERS frame is received.
    
    指定者:
    
    readHeaderBlock 在接口中 SpdyFrameDecoderDelegate
  - readHeaderBlockEnd
```
public void readHeaderBlockEnd()
```
    从接口复制的说明: SpdyFrameDecoderDelegate
    
    Called when an entire header block has been received.
    
    指定者:
    
    readHeaderBlockEnd 在接口中 SpdyFrameDecoderDelegate
  - readFrameError
```
public void readFrameError(java.lang.String message)
```
    从接口复制的说明: SpdyFrameDecoderDelegate
    
    Called when an unrecoverable session error has occurred.
    
    指定者:
    
    readFrameError 在接口中 SpdyFrameDecoderDelegate

类 SpdyFrameCodec

嵌套类概要

从类继承的嵌套类/接口 io.netty.handler.codec.ByteToMessageDecoder

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

字段概要

从类继承的字段 io.netty.handler.codec.ByteToMessageDecoder

构造器概要

方法概要

从类继承的方法 io.netty.handler.codec.ByteToMessageDecoder

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

从类继承的方法 java.lang.Object

从接口继承的方法 io.netty.channel.ChannelHandler

构造器详细资料

SpdyFrameCodec

SpdyFrameCodec

SpdyFrameCodec

SpdyFrameCodec

SpdyFrameCodec

方法详细资料

handlerAdded

decode

channelReadComplete

bind

connect

disconnect

close

deregister

read

flush

write

readDataFrame

readSynStreamFrame

readSynReplyFrame

readRstStreamFrame

readSettingsFrame

readSetting

readSettingsEnd

readPingFrame

readGoAwayFrame

readHeadersFrame

readWindowUpdateFrame

readHeaderBlock

readHeaderBlockEnd

readFrameError