SpdyFrameCodec (Netty API Reference (4.1.22.Final))

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

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler ， ChannelOutboundHandler ， SpdyFrameDecoderDelegate
```
public class SpdyFrameCodec
extends ByteToMessageDecoder
implements SpdyFrameDecoderDelegate, ChannelOutboundHandler
```
编码和解码SPDY帧的ChannelHandler 。

Nested Class Summary
- Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder
  ByteToMessageDecoder.Cumulator
- Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
  ChannelHandler.Sharable

Field Summary
- Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder
  COMPOSITE_CUMULATOR, MERGE_CUMULATOR

构造方法摘要

构造方法
Modifier	Constructor and Description
	`SpdyFrameCodec(SpdyVersion version)` 创建一个新的实例与指定的 `version` ， `validateHeaders (true)` ，默认解码器和编码选项（ `maxChunkSize (8192)` ， `maxHeaderSize (16384)` ， `compressionLevel (6)` ， `windowBits (15)`和 `memLevel (8)` ）。
	`SpdyFrameCodec(SpdyVersion version, boolean validateHeaders)` 创建一个新的实例与指定的 `version` ， `validateHeaders` ，默认解码器和编码选项（ `maxChunkSize (8192)` ， `maxHeaderSize (16384)` ， `compressionLevel (6)` ， `windowBits (15)`和 `memLevel (8)` ）。
	`SpdyFrameCodec(SpdyVersion version, int maxChunkSize, int maxHeaderSize, int compressionLevel, int windowBits, int memLevel)` 创建具有指定一个新的实例 `version` ， `validateHeaders (true)` ，解码器和编码选项。
	`SpdyFrameCodec(SpdyVersion version, int maxChunkSize, int maxHeaderSize, int compressionLevel, int windowBits, int memLevel, boolean validateHeaders)` 创建具有指定一个新的实例 `version` ， `validateHeaders` ，解码器和编码选项。
`protected`	`SpdyFrameCodec(SpdyVersion version, int maxChunkSize, io.netty.handler.codec.spdy.SpdyHeaderBlockDecoder spdyHeaderBlockDecoder, io.netty.handler.codec.spdy.SpdyHeaderBlockEncoder spdyHeaderBlockEncoder, boolean validateHeaders)`

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`void`	`bind(ChannelHandlerContext ctx, java.net.SocketAddress localAddress, ChannelPromise promise)` 调用一次绑定操作。
`void`	`channelReadComplete(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelReadComplete()`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`close(ChannelHandlerContext ctx, ChannelPromise promise)` 一旦进行了密切的操作，就会被调用。
`void`	`connect(ChannelHandlerContext ctx, java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise)` 连接操作完成后调用。
`protected void`	`decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)` 解码从一个`ByteBuf`到另一个。
`void`	`deregister(ChannelHandlerContext ctx, ChannelPromise promise)` 一旦从当前注册的`EventLoop`进行撤销注册操作，就会被调用。
`void`	`disconnect(ChannelHandlerContext ctx, ChannelPromise promise)` 调用一次断开操作。
`void`	`flush(ChannelHandlerContext ctx)` 调用一次冲洗操作。
`void`	`handlerAdded(ChannelHandlerContext ctx)` 子类可以忽略这个方法。
`void`	`read(ChannelHandlerContext ctx)` 拦截 `ChannelHandlerContext.read()` 。
`void`	`readDataFrame(int streamId, boolean last, ByteBuf data)` 在收到数据帧时调用。
`void`	`readFrameError(java.lang.String message)` 当发生不可恢复的会话错误时调用。
`void`	`readGoAwayFrame(int lastGoodStreamId, int statusCode)` 在收到GOAWAY帧时调用。
`void`	`readHeaderBlock(ByteBuf headerBlock)` 当接收到SYN_STREAM，SYN_REPLY或HEADERS帧内的头部块时调用。
`void`	`readHeaderBlockEnd()` 在收到整个标题块时调用。
`void`	`readHeadersFrame(int streamId, boolean last)` 在收到HEADERS帧时调用。
`void`	`readPingFrame(int id)` 在收到PING帧时调用。
`void`	`readRstStreamFrame(int streamId, int statusCode)` 在接收到RST_STREAM帧时调用。
`void`	`readSetting(int id, int value, boolean persistValue, boolean persisted)` 在收到设置框内的单独设置时调用。
`void`	`readSettingsEnd()` 在接收到整个设置帧时调用。
`void`	`readSettingsFrame(boolean clearPersisted)` 在接收到设置帧时调用。
`void`	`readSynReplyFrame(int streamId, boolean last)` 在收到SYN_REPLY帧时调用。
`void`	`readSynStreamFrame(int streamId, int associatedToStreamId, byte priority, boolean last, boolean unidirectional)` 在接收到SYN_STREAM帧时调用。
`void`	`readWindowUpdateFrame(int streamId, int deltaWindowSize)` 在收到WINDOW_UPDATE帧时调用。
`void`	`write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise)` 一旦写入操作被调用，就调用它。

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

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter
channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, isSharable

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

Methods inherited from interface io.netty.channel.ChannelHandler
exceptionCaught, handlerRemoved

- 构造方法详细信息
  - SpdyFrameCodec
```
public SpdyFrameCodec(SpdyVersion version)
```
    创建一个新的实例与指定的 version ， validateHeaders (true) ，默认解码器和编码选项（ maxChunkSize (8192) ， maxHeaderSize (16384) ， compressionLevel (6) ， windowBits (15)和 memLevel (8) ）。
  - SpdyFrameCodec
```
public SpdyFrameCodec(SpdyVersion version,
                      boolean validateHeaders)
```
    创建一个新的实例与指定的 version ， validateHeaders ，默认解码器和编码选项（ maxChunkSize (8192) ， maxHeaderSize (16384) ， compressionLevel (6) ， windowBits (15)和 memLevel (8) ）。
  - SpdyFrameCodec
```
public SpdyFrameCodec(SpdyVersion version,
                      int maxChunkSize,
                      int maxHeaderSize,
                      int compressionLevel,
                      int windowBits,
                      int memLevel)
```
    创建具有指定一个新的实例 version ， validateHeaders (true) ，解码器和编码选项。
  - SpdyFrameCodec
```
public SpdyFrameCodec(SpdyVersion version,
                      int maxChunkSize,
                      int maxHeaderSize,
                      int compressionLevel,
                      int windowBits,
                      int memLevel,
                      boolean validateHeaders)
```
    创建具有指定一个新的实例 version ， validateHeaders ，解码器和编码选项。
  - SpdyFrameCodec
```
protected SpdyFrameCodec(SpdyVersion version,
                         int maxChunkSize,
                         io.netty.handler.codec.spdy.SpdyHeaderBlockDecoder spdyHeaderBlockDecoder,
                         io.netty.handler.codec.spdy.SpdyHeaderBlockEncoder spdyHeaderBlockEncoder,
                         boolean validateHeaders)
```
- 方法详细信息
  - handlerAdded
```
public void handlerAdded(ChannelHandlerContext ctx)
                  throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    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
    
    解码从一个ByteBuf到另一个。该方法将被调用，直到输入ByteBuf在从此方法返回时没有任何可读的内容或直到从输入ByteBuf中没有读取任何内容。
    
    Specified by:
    
    decode在课堂上 ByteToMessageDecoder
    
    参数
    
    ctx - ChannelHandlerContext这ByteToMessageDecoder属于
    
    in - 从中读取数据的ByteBuf
    
    out - 应该添加解码消息的 List
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - channelReadComplete
```
public void channelReadComplete(ChannelHandlerContext ctx)
                         throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelReadComplete()转发至ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelReadComplete在界面 ChannelInboundHandler
    
    重写：
    
    channelReadComplete在课程 ByteToMessageDecoder
    
    异常
    
    java.lang.Exception
  - bind
```
public void bind(ChannelHandlerContext ctx,
                 java.net.SocketAddress localAddress,
                 ChannelPromise promise)
          throws java.lang.Exception
```
    从接口ChannelOutboundHandler复制的描述
    
    调用一次绑定操作。
    
    Specified by:
    
    bind在界面 ChannelOutboundHandler
    
    参数
    
    ctx - 为其进行绑定操作的ChannelHandlerContext
    
    localAddress - 它应该绑定的 SocketAddress
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - connect
```
public void connect(ChannelHandlerContext ctx,
                    java.net.SocketAddress remoteAddress,
                    java.net.SocketAddress localAddress,
                    ChannelPromise promise)
             throws java.lang.Exception
```
    从界面复制的描述： ChannelOutboundHandler
    
    连接操作完成后调用。
    
    Specified by:
    
    connect在界面 ChannelOutboundHandler
    
    参数
    
    ctx - 为其进行连接操作的ChannelHandlerContext
    
    remoteAddress - 它应该连接的 SocketAddress
    
    localAddress - 用作连接源的 SocketAddress
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - disconnect
```
public void disconnect(ChannelHandlerContext ctx,
                       ChannelPromise promise)
                throws java.lang.Exception
```
    从接口ChannelOutboundHandler复制的描述
    
    调用一次断开操作。
    
    Specified by:
    
    disconnect在界面 ChannelOutboundHandler
    
    参数
    
    ctx - 进行断开操作的ChannelHandlerContext
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - close
```
public void close(ChannelHandlerContext ctx,
                  ChannelPromise promise)
           throws java.lang.Exception
```
    从界面复制的描述： ChannelOutboundHandler
    
    一旦进行了密切的操作，就会被调用。
    
    Specified by:
    
    close在界面 ChannelOutboundHandler
    
    参数
    
    ctx - 关闭操作的ChannelHandlerContext
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - deregister
```
public void deregister(ChannelHandlerContext ctx,
                       ChannelPromise promise)
                throws java.lang.Exception
```
    从接口复制的描述： ChannelOutboundHandler
    
    一旦从当前注册的EventLoop进行注销操作，就会被调用。
    
    Specified by:
    
    deregister在界面 ChannelOutboundHandler
    
    参数
    
    ctx - 关闭操作的ChannelHandlerContext
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - read
```
public void read(ChannelHandlerContext ctx)
          throws java.lang.Exception
```
    从界面复制的描述： ChannelOutboundHandler
    
    拦截 ChannelHandlerContext.read() 。
    
    Specified by:
    
    read在界面 ChannelOutboundHandler
    
    异常
    
    java.lang.Exception
  - flush
```
public void flush(ChannelHandlerContext ctx)
           throws java.lang.Exception
```
    从接口复制的描述： ChannelOutboundHandler
    
    调用一次冲洗操作。刷新操作将尝试清除所有以前写入的待处理消息。
    
    Specified by:
    
    flush在界面 ChannelOutboundHandler
    
    参数
    
    ctx - 进行冲洗操作的ChannelHandlerContext
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - write
```
public void write(ChannelHandlerContext ctx,
                  java.lang.Object msg,
                  ChannelPromise promise)
           throws java.lang.Exception
```
    从接口ChannelOutboundHandler复制的描述
    
    一旦写入操作被调用，就调用它。写入操作将通过ChannelPipeline写入消息。一旦Channel.flush()被调用，那些准备好被刷新到实际的Channel
    
    Specified by:
    
    write在界面 ChannelOutboundHandler
    
    参数
    
    ctx - 为其写入操作的ChannelHandlerContext
    
    msg - 写信息
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - readDataFrame
```
public void readDataFrame(int streamId,
                          boolean last,
                          ByteBuf data)
```
    从界面复制的描述： SpdyFrameDecoderDelegate
    
    在收到数据帧时调用。
    
    Specified by:
    
    readDataFrame在界面 SpdyFrameDecoderDelegate
  - readSynStreamFrame
```
public void readSynStreamFrame(int streamId,
                               int associatedToStreamId,
                               byte priority,
                               boolean last,
                               boolean unidirectional)
```
    从界面复制的描述： SpdyFrameDecoderDelegate
    
    在接收到SYN_STREAM帧时调用。不包含名称/值头文件块。请参阅readHeaderBlock（）。
    
    Specified by:
    
    readSynStreamFrame在界面 SpdyFrameDecoderDelegate
  - readSynReplyFrame
```
public void readSynReplyFrame(int streamId,
                              boolean last)
```
    从接口SpdyFrameDecoderDelegate复制的描述
    
    在收到SYN_REPLY帧时调用。不包含名称/值头文件块。请参阅readHeaderBlock（）。
    
    Specified by:
    
    readSynReplyFrame在界面 SpdyFrameDecoderDelegate
  - readRstStreamFrame
```
public void readRstStreamFrame(int streamId,
                               int statusCode)
```
    从接口SpdyFrameDecoderDelegate复制的描述
    
    在接收到RST_STREAM帧时调用。
    
    Specified by:
    
    readRstStreamFrame在界面 SpdyFrameDecoderDelegate
  - readSettingsFrame
```
public void readSettingsFrame(boolean clearPersisted)
```
    从接口复制的描述： SpdyFrameDecoderDelegate
    
    在接收到设置帧时调用。设置不包括在内。请参阅readSetting（）。
    
    Specified by:
    
    readSettingsFrame在界面 SpdyFrameDecoderDelegate
  - readSetting
```
public void readSetting(int id,
                        int value,
                        boolean persistValue,
                        boolean persisted)
```
    从界面复制的描述： SpdyFrameDecoderDelegate
    
    在收到设置框内的单独设置时调用。
    
    Specified by:
    
    readSetting ，界面 SpdyFrameDecoderDelegate
  - readSettingsEnd
```
public void readSettingsEnd()
```
    从接口复制的描述： SpdyFrameDecoderDelegate
    
    在接收到整个设置帧时调用。
    
    Specified by:
    
    readSettingsEnd在界面 SpdyFrameDecoderDelegate
  - readPingFrame
```
public void readPingFrame(int id)
```
    从界面复制的描述： SpdyFrameDecoderDelegate
    
    在收到PING帧时调用。
    
    Specified by:
    
    readPingFrame在界面 SpdyFrameDecoderDelegate
  - readGoAwayFrame
```
public void readGoAwayFrame(int lastGoodStreamId,
                            int statusCode)
```
    从界面复制的描述： SpdyFrameDecoderDelegate
    
    在收到GOAWAY帧时调用。
    
    Specified by:
    
    readGoAwayFrame在界面 SpdyFrameDecoderDelegate
  - readHeadersFrame
```
public void readHeadersFrame(int streamId,
                             boolean last)
```
    从接口SpdyFrameDecoderDelegate复制的描述
    
    在收到HEADERS帧时调用。不包含名称/值头文件块。请参阅readHeaderBlock（）。
    
    Specified by:
    
    readHeadersFrame ，界面 SpdyFrameDecoderDelegate
  - readWindowUpdateFrame
```
public void readWindowUpdateFrame(int streamId,
                                  int deltaWindowSize)
```
    从接口复制的描述： SpdyFrameDecoderDelegate
    
    在收到WINDOW_UPDATE帧时调用。
    
    Specified by:
    
    readWindowUpdateFrame在界面 SpdyFrameDecoderDelegate
  - readHeaderBlock
```
public void readHeaderBlock(ByteBuf headerBlock)
```
    从接口SpdyFrameDecoderDelegate复制的描述
    
    当接收到SYN_STREAM，SYN_REPLY或HEADERS帧内的头部块时调用。
    
    Specified by:
    
    readHeaderBlock ，界面 SpdyFrameDecoderDelegate
  - readHeaderBlockEnd
```
public void readHeaderBlockEnd()
```
    从接口SpdyFrameDecoderDelegate复制的描述
    
    在收到整个标题块时调用。
    
    Specified by:
    
    readHeaderBlockEnd在界面 SpdyFrameDecoderDelegate
  - readFrameError
```
public void readFrameError(java.lang.String message)
```
    从界面复制的描述： SpdyFrameDecoderDelegate
    
    当发生不可恢复的会话错误时调用。
    
    Specified by:
    
    readFrameError在界面 SpdyFrameDecoderDelegate

Class SpdyFrameCodec

Nested Class Summary

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

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

Field Summary

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

构造方法摘要

方法摘要

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

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface 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