Package io.netty5.handler.codec.http2

Interface Http2HeadersEncoder

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DefaultHttp2HeadersEncoder

@UnstableApi
public interface Http2HeadersEncoder
extends AutoCloseable

Encodes Http2Headers into HPACK-encoded headers blocks.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Http2HeadersEncoder.Configuration	Configuration related elements for the Http2HeadersEncoder interface
static interface	Http2HeadersEncoder.SensitivityDetector	Determine if a header name/value pair is treated as sensitive.

Field Summary

Fields

Modifier and Type	Field	Description
static Http2HeadersEncoder.SensitivityDetector	ALWAYS_SENSITIVE	Always return true for Http2HeadersEncoder.SensitivityDetector.isSensitive(CharSequence, CharSequence).
static Http2HeadersEncoder.SensitivityDetector	NEVER_SENSITIVE	Always return false for Http2HeadersEncoder.SensitivityDetector.isSensitive(CharSequence, CharSequence).

Method Summary

Modifier and Type	Method	Description
default 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, io.netty5.buffer.Buffer buffer)	Encodes the given headers and writes the output headers block to the given output buffer.

Field Detail

NEVER_SENSITIVE

static final Http2HeadersEncoder.SensitivityDetector NEVER_SENSITIVE

Always return false for Http2HeadersEncoder.SensitivityDetector.isSensitive(CharSequence, CharSequence).

ALWAYS_SENSITIVE

static final Http2HeadersEncoder.SensitivityDetector ALWAYS_SENSITIVE

Always return true for Http2HeadersEncoder.SensitivityDetector.isSensitive(CharSequence, CharSequence).

Method Detail

close

default void close()

Close the encoder and release all its associated data. By default, this default method does nothing, but if needed, concrete encoders may override this method in order to clean up any resources when closed.

Specified by:

close in interface AutoCloseable

Throws:

IllegalStateException - If this Resource has already been closed.

encodeHeaders

void encodeHeaders(int streamId,
                   Http2Headers headers,
                   io.netty5.buffer.Buffer buffer)
            throws Http2Exception

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

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

configuration

Http2HeadersEncoder.Configuration configuration()

Get the Http2HeadersEncoder.Configuration for this Http2HeadersEncoder