io.netty.handler.codec.http

类 HttpContentCompressor

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.codec.MessageToMessageCodec<HttpRequest,HttpObject>

io.netty.handler.codec.http.HttpContentEncoder

io.netty.handler.codec.http.HttpContentCompressor

所有已实现的接口:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

public class HttpContentCompressor
extends HttpContentEncoder

Compresses an HttpMessage and an HttpContent in gzip or deflate encoding while respecting the "Accept-Encoding" header. If there is no matching encoding, no compression is done. For more information on how this handler modifies the message, please refer to HttpContentEncoder.

嵌套类概要

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

HttpContentEncoder.Result

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

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
HttpContentCompressor() Creates a new handler with the default compression level (6), default window size (15) and default memory level (8).
HttpContentCompressor(CompressionOptions... compressionOptions) Create a new HttpContentCompressor Instance with specified CompressionOptionss and contentSizeThreshold set to 0
HttpContentCompressor(int compressionLevel) 已过时。
HttpContentCompressor(int contentSizeThreshold, CompressionOptions... compressionOptions) Create a new HttpContentCompressor instance with specified CompressionOptionss
HttpContentCompressor(int compressionLevel, int windowBits, int memLevel) 已过时。
HttpContentCompressor(int compressionLevel, int windowBits, int memLevel, int contentSizeThreshold) 已过时。

方法概要

限定符和类型	方法和说明
protected HttpContentEncoder.Result	beginEncode(HttpResponse httpResponse, java.lang.String acceptEncoding) Prepare to encode the HTTP message content.
protected java.lang.String	determineEncoding(java.lang.String acceptEncoding)
protected ZlibWrapper	determineWrapper(java.lang.String acceptEncoding) 已过时。
void	handlerAdded(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.

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

acceptOutboundMessage, channelInactive, decode, encode, handlerRemoved

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

acceptInboundMessage, channelRead, write

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

bind, close, connect, deregister, disconnect, flush, read

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

channelActive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

从类继承的方法 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

构造器详细资料

HttpContentCompressor

public HttpContentCompressor()

Creates a new handler with the default compression level (6), default window size (15) and default memory level (8).

HttpContentCompressor

@Deprecated
public HttpContentCompressor(int compressionLevel)

已过时。

Creates a new handler with the specified compression level, default window size (15) and default memory level (8).

参数:

compressionLevel - 1 yields the fastest compression and 9 yields the best compression. 0 means no compression. The default compression level is 6.

HttpContentCompressor

@Deprecated
public HttpContentCompressor(int compressionLevel,
                                          int windowBits,
                                          int memLevel)

已过时。

Creates a new handler with the specified compression level, window size, and memory level..

参数:

compressionLevel - 1 yields the fastest compression and 9 yields the best compression. 0 means no compression. The default compression level is 6.

windowBits - The base two logarithm of the size of the history buffer. The value should be in the range 9 to 15 inclusive. Larger values result in better compression at the expense of memory usage. The default value is 15.

memLevel - How much memory should be allocated for the internal compression state. 1 uses minimum memory and 9 uses maximum memory. Larger values result in better and faster compression at the expense of memory usage. The default value is 8

HttpContentCompressor

@Deprecated
public HttpContentCompressor(int compressionLevel,
                                          int windowBits,
                                          int memLevel,
                                          int contentSizeThreshold)

已过时。

Creates a new handler with the specified compression level, window size, and memory level..

参数:

compressionLevel - 1 yields the fastest compression and 9 yields the best compression. 0 means no compression. The default compression level is 6.

windowBits - The base two logarithm of the size of the history buffer. The value should be in the range 9 to 15 inclusive. Larger values result in better compression at the expense of memory usage. The default value is 15.

memLevel - How much memory should be allocated for the internal compression state. 1 uses minimum memory and 9 uses maximum memory. Larger values result in better and faster compression at the expense of memory usage. The default value is 8

contentSizeThreshold - The response body is compressed when the size of the response body exceeds the threshold. The value should be a non negative number. 0 will enable compression for all responses.

HttpContentCompressor

public HttpContentCompressor(CompressionOptions... compressionOptions)

Create a new HttpContentCompressor Instance with specified CompressionOptionss and contentSizeThreshold set to 0

参数:

compressionOptions - CompressionOptions or null if the default should be used.

HttpContentCompressor

public HttpContentCompressor(int contentSizeThreshold,
                             CompressionOptions... compressionOptions)

Create a new HttpContentCompressor instance with specified CompressionOptionss

参数:

contentSizeThreshold - The response body is compressed when the size of the response body exceeds the threshold. The value should be a non negative number. 0 will enable compression for all responses.

compressionOptions - CompressionOptions or null if the default should be used.

方法详细资料

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

beginEncode

protected HttpContentEncoder.Result beginEncode(HttpResponse httpResponse,
                                                java.lang.String acceptEncoding)
                                         throws java.lang.Exception

从类复制的说明: HttpContentEncoder

Prepare to encode the HTTP message content.

指定者:

beginEncode 在类中 HttpContentEncoder

参数:

httpResponse - the http response

acceptEncoding - the value of the "Accept-Encoding" header

返回:

the result of preparation, which is composed of the determined target content encoding and a new EmbeddedChannel that encodes the content into the target content encoding. null if acceptEncoding is unsupported or rejected and thus the content should be handled as-is (i.e. no encoding).

抛出:

java.lang.Exception

determineEncoding

protected java.lang.String determineEncoding(java.lang.String acceptEncoding)

determineWrapper

@Deprecated
protected ZlibWrapper determineWrapper(java.lang.String acceptEncoding)

已过时。