DecoratingHttp2FrameWriter (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.handler.codec.http2.DecoratingHttp2FrameWriter

All Implemented Interfaces:

Http2DataWriter ， Http2FrameWriter ，java.io.Closeable，java.lang.AutoCloseable

已知直接子类：

DecoratingHttp2ConnectionEncoder
```
@UnstableApi
public class DecoratingHttp2FrameWriter
extends java.lang.Object
implements Http2FrameWriter
```
围绕另一个Http2FrameWriter实例的装饰器。

Nested Class Summary
- Nested classes/interfaces inherited from interface io.netty.handler.codec.http2.Http2FrameWriter
  Http2FrameWriter.Configuration

构造方法摘要

构造方法
Constructor and Description
`DecoratingHttp2FrameWriter(Http2FrameWriter delegate)`

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`void`	`close()` 关闭此作者并释放所有分配的资源。
`Http2FrameWriter.Configuration`	`configuration()` 获取此`Http2FrameWriter`的配置相关元素
`ChannelFuture`	`writeData(ChannelHandlerContext ctx, int streamId, ByteBuf data, int padding, boolean endStream, ChannelPromise promise)` 将 `DATA`帧写入远程端点。
`ChannelFuture`	`writeFrame(ChannelHandlerContext ctx, byte frameType, int streamId, Http2Flags flags, ByteBuf payload, ChannelPromise promise)` 任何HTTP / 2帧的通用写入方法。
`ChannelFuture`	`writeGoAway(ChannelHandlerContext ctx, int lastStreamId, long errorCode, ByteBuf debugData, ChannelPromise promise)` 将GO_AWAY帧写入远程端点。
`ChannelFuture`	`writeHeaders(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endStream, ChannelPromise promise)` 将HEADERS帧写入远程端点。
`ChannelFuture`	`writeHeaders(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int streamDependency, short weight, boolean exclusive, int padding, boolean endStream, ChannelPromise promise)` 将指定优先级的HEADERS帧写入远程端点。
`ChannelFuture`	`writePing(ChannelHandlerContext ctx, boolean ack, long data, ChannelPromise promise)` 将PING帧写入远程端点。
`ChannelFuture`	`writePriority(ChannelHandlerContext ctx, int streamId, int streamDependency, short weight, boolean exclusive, ChannelPromise promise)` 将PRIORITY帧写入远程端点。
`ChannelFuture`	`writePushPromise(ChannelHandlerContext ctx, int streamId, int promisedStreamId, Http2Headers headers, int padding, ChannelPromise promise)` 将PUSH_PROMISE帧写入远程端点。
`ChannelFuture`	`writeRstStream(ChannelHandlerContext ctx, int streamId, long errorCode, ChannelPromise promise)` 将RST_STREAM帧写入远程端点。
`ChannelFuture`	`writeSettings(ChannelHandlerContext ctx, Http2Settings settings, ChannelPromise promise)` 将一个SETTINGS帧写入远程端点。
`ChannelFuture`	`writeSettingsAck(ChannelHandlerContext ctx, ChannelPromise promise)` 将SETTINGS确认写入远程端点。
`ChannelFuture`	`writeWindowUpdate(ChannelHandlerContext ctx, int streamId, int windowSizeIncrement, ChannelPromise promise)` 将WINDOW_UPDATE帧写入远程端点。

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

- 构造方法详细信息
  - DecoratingHttp2FrameWriter
```
public DecoratingHttp2FrameWriter(Http2FrameWriter delegate)
```
- 方法详细信息
  - writeData
```
public ChannelFuture writeData(ChannelHandlerContext ctx,
                               int streamId,
                               ByteBuf data,
                               int padding,
                               boolean endStream,
                               ChannelPromise promise)
```
    从接口Http2DataWriter复制的描述
    
    将DATA帧写入远程端点。这将导致一个或多个帧被写入上下文。
    
    Specified by:
    
    writeData在界面 Http2DataWriter
    
    参数
    
    ctx - 用于书写的上下文。
    
    streamId - 发送帧的流。
    
    data - 帧的有效载荷。这将通过这种方法发布。
    
    padding - 应添加的其他字节以掩盖真实的内容大小。必须介于0和256（含）之间。一个1字节的填充被编码为值为0的填充长度字段。一个256字节的填充被编码为填充长度字段，值255和填充字节255被附加到帧的末尾。
    
    endStream - 指示这是否是为流发送的最后一帧。
    
    promise - 写作的承诺。
    
    结果
    
    写作的未来。
  - writeHeaders
```
public ChannelFuture writeHeaders(ChannelHandlerContext ctx,
                                  int streamId,
                                  Http2Headers headers,
                                  int padding,
                                  boolean endStream,
                                  ChannelPromise promise)
```
    从接口Http2FrameWriter复制的描述
    
    将HEADERS帧写入远程端点。
    Specified by:
    
    writeHeaders在界面 Http2FrameWriter
    
    参数
    
    ctx - 用于书写的上下文。
    
    streamId - 要发送帧的流。
    
    headers - 要发送的标题。
    
    padding - 应添加的其他字节以掩盖真实的内容大小。必须介于0和256（含）之间。
    
    endStream - 指示这是否是流的最后一个帧。
    
    promise - 写作的承诺。
    
    结果
    写作的未来。 Section 10.5.1声明如下：
    The header block MUST be processed to ensure a consistent connection state, unless the connection is closed.
    如果这个调用修改了HPACK头部状态，你必须抛出连接错误。
    如果这一呼吁没有修改HPACK头状态，你可以自由地抛出一个流错误。
  - writeHeaders
```
public ChannelFuture writeHeaders(ChannelHandlerContext ctx,
                                  int streamId,
                                  Http2Headers headers,
                                  int streamDependency,
                                  short weight,
                                  boolean exclusive,
                                  int padding,
                                  boolean endStream,
                                  ChannelPromise promise)
```
    从接口复制的描述： Http2FrameWriter
    
    将指定优先级的HEADERS帧写入远程端点。
    Specified by:
    
    writeHeaders在界面 Http2FrameWriter
    
    参数
    
    ctx - 用于书写的上下文。
    
    streamId - 要发送帧的流。
    
    headers - 要发送的标题。
    
    streamDependency - 此流应该依赖的流，或者如果它取决于连接，则为0。
    
    weight - 此流的权重。
    
    exclusive - 此流是否应该是其父项的排他依赖项。
    
    padding - 应添加的其他字节以掩盖真实的内容大小。必须介于0和256（含）之间。
    
    endStream - 指示这是否是流发送的最后一帧。
    
    promise - 写作的承诺。
    
    结果
    写作的未来。 Section 10.5.1声明如下：
    The header block MUST be processed to ensure a consistent connection state, unless the connection is closed.
    如果这个调用修改了HPACK头部状态，你必须抛出连接错误。
    如果这一呼吁没有修改HPACK头状态，你可以自由地抛出一个流错误。
  - writePriority
```
public ChannelFuture writePriority(ChannelHandlerContext ctx,
                                   int streamId,
                                   int streamDependency,
                                   short weight,
                                   boolean exclusive,
                                   ChannelPromise promise)
```
    从接口Http2FrameWriter复制的描述
    
    将PRIORITY帧写入远程端点。
    
    Specified by:
    
    writePriority在界面 Http2FrameWriter
    
    参数
    
    ctx - 用于书写的上下文。
    
    streamId - 要发送帧的流。
    
    streamDependency - 此流应该依赖的流，或者如果它取决于连接，则为0。
    
    weight - 此流的权重。
    
    exclusive - 此流是否应该是其父项的排他依赖项。
    
    promise - 写作的承诺。
    
    结果
    
    写作的未来。
  - writeRstStream
```
public ChannelFuture writeRstStream(ChannelHandlerContext ctx,
                                    int streamId,
                                    long errorCode,
                                    ChannelPromise promise)
```
    从接口复制的描述： Http2FrameWriter
    
    将RST_STREAM帧写入远程端点。
    
    Specified by:
    
    writeRstStream在界面 Http2FrameWriter
    
    参数
    
    ctx - 用于书写的上下文。
    
    streamId - 要发送帧的流。
    
    errorCode - 指示故障性质的错误代码。
    
    promise - 写作的承诺。
    
    结果
    
    写作的未来。
  - writeSettings
```
public ChannelFuture writeSettings(ChannelHandlerContext ctx,
                                   Http2Settings settings,
                                   ChannelPromise promise)
```
    从接口复制的描述： Http2FrameWriter
    
    将一个SETTINGS帧写入远程端点。
    
    Specified by:
    
    writeSettings在界面 Http2FrameWriter
    
    参数
    
    ctx - 用于写作的上下文。
    
    settings - 要发送的设置。
    
    promise - 写作的承诺。
    
    结果
    
    写作的未来。
  - writeSettingsAck
```
public ChannelFuture writeSettingsAck(ChannelHandlerContext ctx,
                                      ChannelPromise promise)
```
    从接口Http2FrameWriter复制的描述
    
    将SETTINGS确认写入远程端点。
    
    Specified by:
    
    writeSettingsAck在界面 Http2FrameWriter
    
    参数
    
    ctx - 用于书写的上下文。
    
    promise - 写作的承诺。
    
    结果
    
    写作的未来。
  - writePing
```
public ChannelFuture writePing(ChannelHandlerContext ctx,
                               boolean ack,
                               long data,
                               ChannelPromise promise)
```
    从界面复制的描述： Http2FrameWriter
    
    将PING帧写入远程端点。
    
    Specified by:
    
    writePing接口 Http2FrameWriter
    
    参数
    
    ctx - 用于书写的上下文。
    
    ack - 指示这是否是先前从远程端点接收到的PING帧的确认。
    
    data - 帧的有效载荷。
    
    promise - 写作的承诺。
    
    结果
    
    写作的未来。
  - writePushPromise
```
public ChannelFuture writePushPromise(ChannelHandlerContext ctx,
                                      int streamId,
                                      int promisedStreamId,
                                      Http2Headers headers,
                                      int padding,
                                      ChannelPromise promise)
```
    从接口复制的描述： Http2FrameWriter
    
    将PUSH_PROMISE帧写入远程端点。
    Specified by:
    
    writePushPromise接口 Http2FrameWriter
    
    参数
    
    ctx - 用于书写的上下文。
    
    streamId - 要发送帧的流。
    
    promisedStreamId - 承诺流的ID。
    
    headers - 要发送的标题。
    
    padding - 应添加的其他字节以掩盖真实的内容大小。必须介于0和256（含）之间。
    
    promise - 写作的承诺。
    
    结果
    写作的未来。 Section 10.5.1声明如下：
    The header block MUST be processed to ensure a consistent connection state, unless the connection is closed.
    如果这个调用修改了HPACK头部状态，你必须抛出连接错误。
    如果这一呼吁没有修改HPACK头状态，你可以自由地抛出一个流错误。
  - writeGoAway
```
public ChannelFuture writeGoAway(ChannelHandlerContext ctx,
                                 int lastStreamId,
                                 long errorCode,
                                 ByteBuf debugData,
                                 ChannelPromise promise)
```
    从界面复制的描述： Http2FrameWriter
    
    将GO_AWAY帧写入远程端点。
    
    Specified by:
    
    writeGoAway在界面 Http2FrameWriter
    
    参数
    
    ctx - 用于书写的上下文。
    
    lastStreamId - 此端点的最后一个已知流。
    
    errorCode - 错误代码，如果连接异常终止。
    
    debugData - 应用程序定义的调试数据。这将通过这种方法发布。
    
    promise - 写作的承诺。
    
    结果
    
    写作的未来。
  - writeWindowUpdate
```
public ChannelFuture writeWindowUpdate(ChannelHandlerContext ctx,
                                       int streamId,
                                       int windowSizeIncrement,
                                       ChannelPromise promise)
```
    从界面复制的描述： Http2FrameWriter
    
    将WINDOW_UPDATE帧写入远程端点。
    
    Specified by:
    
    writeWindowUpdate在界面 Http2FrameWriter
    
    参数
    
    ctx - 用于书写的上下文。
    
    streamId - 要发送帧的流。
    
    windowSizeIncrement - 本地入站流量控制窗口增加的字节数。
    
    promise - 写作的承诺。
    
    结果
    
    写作的未来。
  - writeFrame
```
public ChannelFuture writeFrame(ChannelHandlerContext ctx,
                                byte frameType,
                                int streamId,
                                Http2Flags flags,
                                ByteBuf payload,
                                ChannelPromise promise)
```
    从界面复制的描述： Http2FrameWriter
    
    任何HTTP / 2帧的通用写入方法。这允许写入非标准帧。
    
    Specified by:
    
    writeFrame ，界面 Http2FrameWriter
    
    参数
    
    ctx - 用于书写的上下文。
    
    frameType - 帧类型标识符。
    
    streamId - 要发送帧的流。
    
    flags - 为此帧写入的标志。
    
    payload - 为此帧写入的有效负载。这将通过这种方法发布。
    
    promise - 写作的承诺。
    
    结果
    
    写作的未来。
  - configuration
```
public Http2FrameWriter.Configuration configuration()
```
    从接口复制的描述： Http2FrameWriter
    
    获取此Http2FrameWriter的配置相关元素
    
    Specified by:
    
    configuration在界面 Http2FrameWriter
  - close
```
public void close()
```
    从接口Http2FrameWriter复制的描述
    
    关闭此作者并释放所有分配的资源。
    
    Specified by:
    
    close在界面 Http2FrameWriter
    
    Specified by:
    
    close在界面 java.io.Closeable
    
    Specified by:
    
    close ，界面 java.lang.AutoCloseable

Class DecoratingHttp2FrameWriter

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.handler.codec.http2.Http2FrameWriter

构造方法摘要

方法摘要

Methods inherited from class java.lang.Object

构造方法详细信息

DecoratingHttp2FrameWriter

方法详细信息

writeData

writeHeaders

writeHeaders

writePriority

writeRstStream

writeSettings

writeSettingsAck

writePing

writePushPromise

writeGoAway

writeWindowUpdate

writeFrame

configuration

close