CompressorHttp2ConnectionEncoder (Netty API Reference (4.1.22.Final))

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

All Implemented Interfaces:

Http2ConnectionEncoder ， Http2DataWriter ， Http2FrameWriter ，java.io.Closeable，java.lang.AutoCloseable
```
@UnstableApi
public class CompressorHttp2ConnectionEncoder
extends DecoratingHttp2ConnectionEncoder
```
装饰HTTP2编码器，将根据每个流的content-encoding标头压缩数据帧。此类提供的压缩将应用于整个流的数据。

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_COMPRESSION_LEVEL`
`static int`	`DEFAULT_MEM_LEVEL`
`static int`	`DEFAULT_WINDOW_BITS`

构造方法摘要

构造方法
Constructor and Description
`CompressorHttp2ConnectionEncoder(Http2ConnectionEncoder delegate)`
`CompressorHttp2ConnectionEncoder(Http2ConnectionEncoder delegate, int compressionLevel, int windowBits, int memLevel)`

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`protected java.lang.CharSequence`	`getTargetContentEncoding(java.lang.CharSequence contentEncoding)` 返回解码内容的预期内容编码。
`protected EmbeddedChannel`	`newContentCompressor(ChannelHandlerContext ctx, java.lang.CharSequence contentEncoding)` 返回一个新`EmbeddedChannel`编码指定编码的HTTP2消息内容`contentEncoding` 。
`ChannelFuture`	`writeData(ChannelHandlerContext ctx, int streamId, ByteBuf data, int padding, boolean endOfStream, ChannelPromise promise)` 将 `DATA`帧写入远程端点。
`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 endOfStream, ChannelPromise promise)` 将指定优先级的HEADERS帧写入远程端点。

Methods inherited from class io.netty.handler.codec.http2.DecoratingHttp2ConnectionEncoder
connection, flowController, frameWriter, lifecycleManager, pollSentSettings, remoteSettings

Methods inherited from class io.netty.handler.codec.http2.DecoratingHttp2FrameWriter
close, configuration, writeFrame, writeGoAway, writePing, writePriority, writePushPromise, writeRstStream, writeSettings, writeSettingsAck, writeWindowUpdate

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

Methods inherited from interface io.netty.handler.codec.http2.Http2ConnectionEncoder
writeFrame

Methods inherited from interface io.netty.handler.codec.http2.Http2FrameWriter
close, configuration, writeGoAway, writePing, writePriority, writePushPromise, writeRstStream, writeSettings, writeSettingsAck, writeWindowUpdate

- 字段详细信息
  - DEFAULT_COMPRESSION_LEVEL
```
public static final int DEFAULT_COMPRESSION_LEVEL
```
    另请参见：
    
    Constant Field Values
  - DEFAULT_WINDOW_BITS
```
public static final int DEFAULT_WINDOW_BITS
```
    另请参见：
    
    Constant Field Values
  - DEFAULT_MEM_LEVEL
```
public static final int DEFAULT_MEM_LEVEL
```
    另请参见：
    
    Constant Field Values
- 构造方法详细信息
  - CompressorHttp2ConnectionEncoder
```
public CompressorHttp2ConnectionEncoder(Http2ConnectionEncoder delegate)
```
  - CompressorHttp2ConnectionEncoder
```
public CompressorHttp2ConnectionEncoder(Http2ConnectionEncoder delegate,
                                        int compressionLevel,
                                        int windowBits,
                                        int memLevel)
```
- 方法详细信息
  - writeData
```
public ChannelFuture writeData(ChannelHandlerContext ctx,
                               int streamId,
                               ByteBuf data,
                               int padding,
                               boolean endOfStream,
                               ChannelPromise promise)
```
    从接口复制的描述： Http2DataWriter
    
    将DATA帧写入远程端点。这将导致一个或多个帧被写入上下文。
    
    Specified by:
    
    writeData在界面 Http2DataWriter
    
    重写：
    
    writeData DecoratingHttp2FrameWriter
    
    参数
    
    ctx - 用于书写的上下文。
    
    streamId - 要发送帧的流。
    
    data - 帧的有效载荷。这将通过这种方法发布。
    
    padding - 应添加的其他字节以掩盖真实的内容大小。必须介于0和256（含）之间。一个1字节的填充被编码为值为0的填充长度字段。一个256字节的填充被编码为填充长度字段，值255和填充字节255被附加到帧的末尾。
    
    endOfStream - 指示这是否是为流发送的最后一帧。
    
    promise - 写作的承诺。
    
    结果
    
    写作的未来。
  - writeHeaders
```
public ChannelFuture writeHeaders(ChannelHandlerContext ctx,
                                  int streamId,
                                  Http2Headers headers,
                                  int padding,
                                  boolean endStream,
                                  ChannelPromise promise)
```
    从接口复制的描述： Http2FrameWriter
    
    将HEADERS帧写入远程端点。
    Specified by:
    
    writeHeaders在界面 Http2FrameWriter
    
    重写：
    
    writeHeaders DecoratingHttp2FrameWriter
    
    参数
    
    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 endOfStream,
                                  ChannelPromise promise)
```
    从接口复制的描述： Http2FrameWriter
    
    将指定优先级的HEADERS帧写入远程端点。
    Specified by:
    
    writeHeaders在界面 Http2FrameWriter
    
    重写：
    
    writeHeaders在课堂上 DecoratingHttp2FrameWriter
    
    参数
    
    ctx - 用于书写的上下文。
    
    streamId - 要发送帧的流。
    
    headers - 要发送的标题。
    
    streamDependency - 此流应该依赖的流，或者如果它取决于连接，则为0。
    
    weight - 这个流的重量。
    
    exclusive - 此流是否应该是其父项的排他依赖项。
    
    padding - 应添加的其他字节以掩盖真实的内容大小。必须介于0和256（含）之间。
    
    endOfStream - 指示这是否是为流发送的最后一帧。
    
    promise - 写作的承诺。
    
    结果
    写作的未来。 Section 10.5.1声明如下：
    The header block MUST be processed to ensure a consistent connection state, unless the connection is closed.
    如果这个调用修改了HPACK头部状态，你必须抛出连接错误。
    如果这一呼吁没有修改HPACK头状态，你可以自由地抛出一个流错误。
  - newContentCompressor
```
protected EmbeddedChannel newContentCompressor(ChannelHandlerContext ctx,
                                               java.lang.CharSequence contentEncoding)
                                        throws Http2Exception
```
    返回一个新的EmbeddedChannel ，它编码在指定的contentEncoding编码的contentEncoding消息内容。
    
    参数
    
    ctx - 上下文。
    
    contentEncoding - content-encoding标题的值
    
    结果
    
    如果支持指定的编码，则新的ByteToMessageDecoder 。否则null （或者，您可以抛出Http2Exception来阻止未知编码）。
    
    异常
    
    Http2Exception - 如果指定的编码不是不受支持的并且保证有异常
  - getTargetContentEncoding
```
protected java.lang.CharSequence getTargetContentEncoding(java.lang.CharSequence contentEncoding)
                                                   throws Http2Exception
```
    返回解码内容的预期内容编码。返回contentEncoding是默认行为，大多数压缩机都是如此。
    
    参数
    
    contentEncoding - content-encoding标题的值
    
    结果
    
    新内容的预期内容编码。
    
    异常
    
    Http2Exception - if the contentEncoding is not supported and warrants an exception

Class CompressorHttp2ConnectionEncoder

Nested Class Summary

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

Field Summary

构造方法摘要

方法摘要

Methods inherited from class io.netty.handler.codec.http2.DecoratingHttp2ConnectionEncoder

Methods inherited from class io.netty.handler.codec.http2.DecoratingHttp2FrameWriter

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.handler.codec.http2.Http2ConnectionEncoder

Methods inherited from interface io.netty.handler.codec.http2.Http2FrameWriter

字段详细信息

DEFAULT_COMPRESSION_LEVEL

DEFAULT_WINDOW_BITS

DEFAULT_MEM_LEVEL

构造方法详细信息

CompressorHttp2ConnectionEncoder

CompressorHttp2ConnectionEncoder

方法详细信息

writeData

writeHeaders

writeHeaders

newContentCompressor

getTargetContentEncoding