io.netty.handler.codec.http2

Class CompressorHttp2ConnectionEncoder

java.lang.Object

io.netty.handler.codec.http2.DefaultHttp2ConnectionEncoder

io.netty.handler.codec.http2.CompressorHttp2ConnectionEncoder

All Implemented Interfaces:

Http2ConnectionEncoder, Http2DataWriter, Http2FrameWriter, Closeable, AutoCloseable

public class CompressorHttp2ConnectionEncoder
extends DefaultHttp2ConnectionEncoder

A HTTP2 encoder that will compress data frames according to the content-encoding header for each stream. The compression provided by this class will be applied to the data for the entire stream.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompressorHttp2ConnectionEncoder.Builder Builder for new instances of CompressorHttp2ConnectionEncoder

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

DefaultHttp2ConnectionEncoder.FlowControlledBase

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

Http2FrameWriter.Configuration

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CompressorHttp2ConnectionEncoder(CompressorHttp2ConnectionEncoder.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
protected io.netty.handler.codec.AsciiString	getTargetContentEncoding(io.netty.handler.codec.AsciiString contentEncoding) Returns the expected content encoding of the decoded content.
protected io.netty.channel.embedded.EmbeddedChannel	newContentCompressor(io.netty.handler.codec.AsciiString contentEncoding) Returns a new EmbeddedChannel that encodes the HTTP2 message content encoded in the specified contentEncoding.
io.netty.channel.ChannelFuture	writeData(io.netty.channel.ChannelHandlerContext ctx, int streamId, io.netty.buffer.ByteBuf data, int padding, boolean endOfStream, io.netty.channel.ChannelPromise promise) Writes a DATA frame to the remote endpoint.
io.netty.channel.ChannelFuture	writeHeaders(io.netty.channel.ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endStream, io.netty.channel.ChannelPromise promise) Writes a HEADERS frame to the remote endpoint.
io.netty.channel.ChannelFuture	writeHeaders(io.netty.channel.ChannelHandlerContext ctx, int streamId, Http2Headers headers, int streamDependency, short weight, boolean exclusive, int padding, boolean endOfStream, io.netty.channel.ChannelPromise promise) Writes a HEADERS frame with priority specified to the remote endpoint.

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

close, configuration, connection, flowController, frameWriter, newBuilder, pollSentSettings, remoteSettings, writeFrame, writeGoAway, writePing, writePriority, writePushPromise, writeRstStream, writeRstStream, writeSettings, writeSettingsAck, writeWindowUpdate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CompressorHttp2ConnectionEncoder

protected CompressorHttp2ConnectionEncoder(CompressorHttp2ConnectionEncoder.Builder builder)

Method Detail

writeData

public io.netty.channel.ChannelFuture writeData(io.netty.channel.ChannelHandlerContext ctx,
                                       int streamId,
                                       io.netty.buffer.ByteBuf data,
                                       int padding,
                                       boolean endOfStream,
                                       io.netty.channel.ChannelPromise promise)

Description copied from interface: Http2DataWriter

Writes a DATA frame to the remote endpoint.

Specified by:

writeData in interface Http2DataWriter

Overrides:

writeData in class DefaultHttp2ConnectionEncoder

Parameters:

ctx - the context to use for writing.

streamId - the stream for which to send the frame.

data - the payload of the frame. This will be released by this method.

padding - the amount of padding to be added to the end of the frame

endOfStream - indicates if this is the last frame to be sent for the stream.

promise - the promise for the write.

Returns:

the future for the write.

writeHeaders

public io.netty.channel.ChannelFuture writeHeaders(io.netty.channel.ChannelHandlerContext ctx,
                                          int streamId,
                                          Http2Headers headers,
                                          int padding,
                                          boolean endStream,
                                          io.netty.channel.ChannelPromise promise)

Description copied from interface: Http2FrameWriter

Writes a HEADERS frame to the remote endpoint.

Specified by:

writeHeaders in interface Http2FrameWriter

Overrides:

writeHeaders in class DefaultHttp2ConnectionEncoder

Parameters:

ctx - the context to use for writing.

streamId - the stream for which to send the frame.

headers - the headers to be sent.

padding - the amount of padding to be added to the end of the frame

endStream - indicates if this is the last frame to be sent for the stream.

promise - the promise for the write.

Returns:

the future for the write.

writeHeaders

public io.netty.channel.ChannelFuture writeHeaders(io.netty.channel.ChannelHandlerContext ctx,
                                          int streamId,
                                          Http2Headers headers,
                                          int streamDependency,
                                          short weight,
                                          boolean exclusive,
                                          int padding,
                                          boolean endOfStream,
                                          io.netty.channel.ChannelPromise promise)

Description copied from interface: Http2FrameWriter

Writes a HEADERS frame with priority specified to the remote endpoint.

Specified by:

writeHeaders in interface Http2FrameWriter

Overrides:

writeHeaders in class DefaultHttp2ConnectionEncoder

Parameters:

ctx - the context to use for writing.

streamId - the stream for which to send the frame.

headers - the headers to be sent.

streamDependency - the stream on which this stream should depend, or 0 if it should depend on the connection.

weight - the weight for this stream.

exclusive - whether this stream should be the exclusive dependant of its parent.

padding - the amount of padding to be added to the end of the frame

endOfStream - indicates if this is the last frame to be sent for the stream.

promise - the promise for the write.

Returns:

the future for the write.

newContentCompressor

protected io.netty.channel.embedded.EmbeddedChannel newContentCompressor(io.netty.handler.codec.AsciiString contentEncoding)
                                                                  throws Http2Exception

Returns a new EmbeddedChannel that encodes the HTTP2 message content encoded in the specified contentEncoding.

Parameters:

contentEncoding - the value of the content-encoding header

Returns:

a new ByteToMessageDecoder if the specified encoding is supported. null otherwise (alternatively, you can throw a Http2Exception to block unknown encoding).

Throws:

Http2Exception - If the specified encoding is not not supported and warrants an exception

getTargetContentEncoding

protected io.netty.handler.codec.AsciiString getTargetContentEncoding(io.netty.handler.codec.AsciiString contentEncoding)
                                                               throws Http2Exception

Returns the expected content encoding of the decoded content. Returning contentEncoding is the default behavior, which is the case for most compressors.

Parameters:

contentEncoding - the value of the content-encoding header

Returns:

the expected content encoding of the new content.

Throws:

Http2Exception - if the contentEncoding is not supported and warrants an exception