Http2FrameCodec (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.http2.Http2ConnectionHandler
      - io.netty.handler.codec.http2.Http2FrameCodec

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler ， ChannelOutboundHandler ， Http2LifecycleManager

已知直接子类：

Http2MultiplexCodec
```
@UnstableApi
public class Http2FrameCodec
extends Http2ConnectionHandler
```
这个API非常不成熟。 基于Http2Connection的API目前优于此API。该API旨在最终取代或减少对Http2ConnectionHandler API的需求。

将HTTP / 2帧映射到Http2Frame对象的HTTP / 2处理程序，反之亦然。对于每个传入的HTTP / 2帧，都会创建一个Http2Frame对象并通过ByteToMessageDecoder.channelRead(io.netty.channel.ChannelHandlerContext, java.lang.Object)传播。通过write(io.netty.channel.ChannelHandlerContext, java.lang.Object, io.netty.channel.ChannelPromise)收到的出站Http2Frame对象将转换为HTTP / 2线格式。特定于流的HTTP / 2帧实现Http2StreamFrame接口。 Http2FrameCodec使用Http2FrameCodecBuilder实例化。建议渠道处理程序从Http2ChannelDuplexHandler继承，因为它提供了其他功能，例如遍历所有活动流或创建出站流。

流生命周期
帧编解码器为活动流传送和写入帧。当任何一方发送RST_STREAM帧或者双方都发送带有END_STREAM标志设置的帧时，活动流将关闭。每个Http2StreamFrame都有一个Http2FrameStream对象，用于唯一标识特定的流。
Http2StreamFrame通常从通道读取Http2FrameStream对象集，而在编写Http2StreamFrame时，应用程序代码需要使用Http2StreamFrame.stream(Http2FrameStream)设置Http2FrameStream对象。

流量控制
帧编解码器会自动增加流和连接流控制窗口。
通过写入Http2WindowUpdateFrame消耗的字节数和相应的流标识符设置为帧编解码器，需要消耗流入受控帧。

本地流级别流量控制窗口可通过编写一个Http2SettingsFrame并将Http2Settings.initialWindowSize()设置为目标值来更改。

连接级流量控制窗口可通过以Http2WindowUpdateFrame写入所需的窗口大小增量（以字节为单位）并将流标识符设置为0来0 。默认情况下，初始连接级别流控制窗口与初始流级别流控制窗口相同。

新的入站流
HTTP / 2流的第一帧必须是Http2HeadersFrame ，它将连接Http2FrameStream对象。
新的出站流
出站HTTP / 2流可以通过以下方式创建：首先通过Http2ChannelDuplexHandler.newStream()实例化新的Http2FrameStream对象，然后用连接的流写入Http2HeadersFrame对象。
```
  final Http2Stream2 stream = handler.newStream();
     ctx.write(headersFrame.stream(stream)).addListener(new ChannelFutureListener() { 
```

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 and Type	Method and Description
`void`	`handlerAdded(ChannelHandlerContext ctx)` 子类可以忽略这个方法。
`protected boolean`	`isGracefulShutdownComplete()` 由优雅的关机逻辑调用以确定何时可以安全地关闭连接。
`protected void`	`onConnectionError(ChannelHandlerContext ctx, boolean outbound, java.lang.Throwable cause, Http2Exception http2Ex)` 处理程序出现连接错误。
`protected void`	`onStreamError(ChannelHandlerContext ctx, boolean outbound, java.lang.Throwable cause, Http2Exception.StreamException streamException)` 对于未知数据流的异常情况，即没有附加`Http2FrameStream`对象的数据流将被记录并通过发送RST_STREAM帧进行回复。
`void`	`userEventTriggered(ChannelHandlerContext ctx, java.lang.Object evt)` 处理明文HTTP升级事件。
`void`	`write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise)` 处理所有`Http2Frame` s。

Methods inherited from class io.netty.handler.codec.http2.Http2ConnectionHandler
bind, channelActive, channelInactive, channelReadComplete, channelWritabilityChanged, close, closeStream, closeStreamLocal, closeStreamRemote, connect, connection, decode, decoder, deregister, disconnect, encoder, exceptionCaught, flush, frameWriter, goAway, gracefulShutdownTimeoutMillis, gracefulShutdownTimeoutMillis, handlerRemoved0, handleServerHeaderDecodeSizeError, onError, onHttpClientUpgrade, onHttpServerUpgrade, read, resetStream

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

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

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
handlerRemoved

- 方法详细信息
  - handlerAdded
```
public final void handlerAdded(ChannelHandlerContext ctx)
                        throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerAdded ，界面 ChannelHandler
    
    重写：
    
    handlerAdded Http2ConnectionHandler
    
    异常
    
    java.lang.Exception
  - userEventTriggered
```
public final void userEventTriggered(ChannelHandlerContext ctx,
                                     java.lang.Object evt)
                              throws java.lang.Exception
```
    处理明文HTTP升级事件。如果发生升级，则通过流1上的HTTP / 2发送简单响应（该流专门用于明文HTTP升级）。
    
    Specified by:
    
    userEventTriggered在界面 ChannelInboundHandler
    
    重写：
    
    userEventTriggered在课堂上 ByteToMessageDecoder
    
    异常
    
    java.lang.Exception
  - write
```
public void write(ChannelHandlerContext ctx,
                  java.lang.Object msg,
                  ChannelPromise promise)
```
    处理全部Http2Frame s。 Http2StreamFrame s可能只起源于子流。
    
    Specified by:
    
    write在界面 ChannelOutboundHandler
    
    重写：
    
    write在课堂上 Http2ConnectionHandler
    
    参数
    
    ctx - 为其写入操作的ChannelHandlerContext
    
    msg - 写信息
    
    promise - 在操作完成后通知ChannelPromise
  - onConnectionError
```
protected void onConnectionError(ChannelHandlerContext ctx,
                                 boolean outbound,
                                 java.lang.Throwable cause,
                                 Http2Exception http2Ex)
```
    从类复制的描述： Http2ConnectionHandler
    
    处理程序出现连接错误。将GO_AWAY帧发送到远程端点。一旦所有流都关闭，连接就会关闭。
    
    重写：
    
    onConnectionError在课堂上 Http2ConnectionHandler
    
    参数
    
    ctx - 频道上下文
    
    outbound - true如果错误是由出站操作引起的。
    
    cause - 被发现的例外情况
    
    http2Ex - 嵌入因果关系链中的Http2Exception 。这可能是null如果它是未知的例外。
  - onStreamError
```
protected final void onStreamError(ChannelHandlerContext ctx,
                                   boolean outbound,
                                   java.lang.Throwable cause,
                                   Http2Exception.StreamException streamException)
```
    对于未知数据流的例外情况，即没有附加Http2FrameStream对象的数据流将被记录并通过发送RST_STREAM帧进行回复。
    
    重写：
    
    onStreamError在课堂上 Http2ConnectionHandler
    
    参数
    
    ctx - 频道上下文
    
    outbound - true如果错误是由出站操作引起的。
    
    cause - 被捕的异常
    
    streamException - 嵌入因果关系链中的Http2Exception.StreamException 。
  - isGracefulShutdownComplete
```
protected final boolean isGracefulShutdownComplete()
```
    从类复制的描述： Http2ConnectionHandler
    
    由优雅的关机逻辑调用以确定何时可以安全地关闭连接。如果正常关机已完成并且可以安全关闭连接，则返回true 。这个实现只保证没有活动流。子类可能会覆盖以提供额外的检查。
    
    重写：
    
    isGracefulShutdownComplete在课堂上 Http2ConnectionHandler

Class Http2FrameCodec

流生命周期

流量控制

新的入站流

新的出站流

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.http2.Http2ConnectionHandler

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

方法详细信息

handlerAdded

userEventTriggered

write

onConnectionError

onStreamError

isGracefulShutdownComplete