Class DefaultHttp2HeadersEncoder

java.lang.Object

io.netty.handler.codec.http2.DefaultHttp2HeadersEncoder

All Implemented Interfaces:

Http2HeadersEncoder, Http2HeadersEncoder.Configuration, java.io.Closeable, java.lang.AutoCloseable

public class DefaultHttp2HeadersEncoder
extends java.lang.Object
implements Http2HeadersEncoder, Http2HeadersEncoder.Configuration, java.io.Closeable

Nested Class Summary

Nested classes/interfaces inherited from interface Http2HeadersEncoder

Http2HeadersEncoder.Configuration, Http2HeadersEncoder.SensitivityDetector

Field Summary

Fields

Modifier and Type	Field	Description
private final HpackEncoder	hpackEncoder
private final Http2HeadersEncoder.SensitivityDetector	sensitivityDetector

Fields inherited from interface Http2HeadersEncoder

ALWAYS_SENSITIVE, NEVER_SENSITIVE

Constructor Summary

Constructors

Constructor	Description
DefaultHttp2HeadersEncoder()
DefaultHttp2HeadersEncoder(Http2HeadersEncoder.SensitivityDetector sensitivityDetector)
DefaultHttp2HeadersEncoder(Http2HeadersEncoder.SensitivityDetector sensitivityDetector, boolean ignoreMaxHeaderListSize)
DefaultHttp2HeadersEncoder(Http2HeadersEncoder.SensitivityDetector sensitivityDetector, boolean ignoreMaxHeaderListSize, int dynamicTableArraySizeHint)
DefaultHttp2HeadersEncoder(Http2HeadersEncoder.SensitivityDetector sensitivityDetector, boolean ignoreMaxHeaderListSize, int dynamicTableArraySizeHint, int huffCodeThreshold)
DefaultHttp2HeadersEncoder(Http2HeadersEncoder.SensitivityDetector sensitivityDetector, HpackEncoder hpackEncoder)	Exposed Used for testing only! Default values used in the initial settings frame are overridden intentionally for testing but violate the RFC if used outside the scope of testing.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the encoder and release all its associated data.
Http2HeadersEncoder.Configuration	configuration()	Get the Http2HeadersEncoder.Configuration for this Http2HeadersEncoder
void	encodeHeaders(int streamId, Http2Headers headers, ByteBuf buffer)	Encodes the given headers and writes the output headers block to the given output buffer.
long	maxHeaderListSize()	Represents the value for SETTINGS_MAX_HEADER_LIST_SIZE.
void	maxHeaderListSize(long max)	Represents the value for SETTINGS_MAX_HEADER_LIST_SIZE.
long	maxHeaderTableSize()	Represents the value for SETTINGS_HEADER_TABLE_SIZE.
void	maxHeaderTableSize(long max)	Represents the value for SETTINGS_HEADER_TABLE_SIZE.

Methods inherited from class java.lang.Object

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

Field Details

hpackEncoder

private final HpackEncoder hpackEncoder

sensitivityDetector

private final Http2HeadersEncoder.SensitivityDetector sensitivityDetector

Constructor Details

DefaultHttp2HeadersEncoder

public DefaultHttp2HeadersEncoder()

DefaultHttp2HeadersEncoder

public DefaultHttp2HeadersEncoder(Http2HeadersEncoder.SensitivityDetector sensitivityDetector)

DefaultHttp2HeadersEncoder

public DefaultHttp2HeadersEncoder(Http2HeadersEncoder.SensitivityDetector sensitivityDetector,
 boolean ignoreMaxHeaderListSize)

DefaultHttp2HeadersEncoder

public DefaultHttp2HeadersEncoder(Http2HeadersEncoder.SensitivityDetector sensitivityDetector,
 boolean ignoreMaxHeaderListSize,
 int dynamicTableArraySizeHint)

DefaultHttp2HeadersEncoder

public DefaultHttp2HeadersEncoder(Http2HeadersEncoder.SensitivityDetector sensitivityDetector,
 boolean ignoreMaxHeaderListSize,
 int dynamicTableArraySizeHint,
 int huffCodeThreshold)

DefaultHttp2HeadersEncoder

DefaultHttp2HeadersEncoder(Http2HeadersEncoder.SensitivityDetector sensitivityDetector,
 HpackEncoder hpackEncoder)

Exposed Used for testing only! Default values used in the initial settings frame are overridden intentionally for testing but violate the RFC if used outside the scope of testing.

Method Details

encodeHeaders

public void encodeHeaders(int streamId,
 Http2Headers headers,
 ByteBuf buffer)
                   throws Http2Exception

Description copied from interface: Http2HeadersEncoder

Encodes the given headers and writes the output headers block to the given output buffer.

Specified by:

encodeHeaders in interface Http2HeadersEncoder

Parameters:

streamId - the identifier of the stream for which the headers are encoded.

headers - the headers to be encoded.

buffer - the buffer to receive the encoded headers.

Throws:

Http2Exception

maxHeaderTableSize

public void maxHeaderTableSize(long max)
                        throws Http2Exception

Description copied from interface: Http2HeadersEncoder.Configuration

Represents the value for SETTINGS_HEADER_TABLE_SIZE. This method should only be called by Netty (not users) as a result of a receiving a SETTINGS frame.

Specified by:

maxHeaderTableSize in interface Http2HeadersEncoder.Configuration

Throws:

Http2Exception

maxHeaderTableSize

public long maxHeaderTableSize()

Description copied from interface: Http2HeadersEncoder.Configuration

Represents the value for SETTINGS_HEADER_TABLE_SIZE. The initial value returned by this method must be Http2CodecUtil.DEFAULT_HEADER_TABLE_SIZE.

Specified by:

maxHeaderTableSize in interface Http2HeadersEncoder.Configuration

maxHeaderListSize

public void maxHeaderListSize(long max)
                       throws Http2Exception

Description copied from interface: Http2HeadersEncoder.Configuration

Represents the value for SETTINGS_MAX_HEADER_LIST_SIZE. This method should only be called by Netty (not users) as a result of a receiving a SETTINGS frame.

Specified by:

maxHeaderListSize in interface Http2HeadersEncoder.Configuration

Throws:

Http2Exception

maxHeaderListSize

public long maxHeaderListSize()

Description copied from interface: Http2HeadersEncoder.Configuration

Represents the value for SETTINGS_MAX_HEADER_LIST_SIZE.

Specified by:

maxHeaderListSize in interface Http2HeadersEncoder.Configuration

configuration

public Http2HeadersEncoder.Configuration configuration()

Description copied from interface: Http2HeadersEncoder

Get the Http2HeadersEncoder.Configuration for this Http2HeadersEncoder

Specified by:

configuration in interface Http2HeadersEncoder

close

public void close()

Close the encoder and release all its associated data.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable