Package io.servicetalk.http.netty

Class H2ProtocolConfigBuilder

java.lang.Object

io.servicetalk.http.netty.H2ProtocolConfigBuilder

public final class H2ProtocolConfigBuilder
extends Object

Builder for H2ProtocolConfig.

See Also:

• HttpProtocolConfigs.h2()

Method Summary

Modifier and Type	Method	Description
H2ProtocolConfig	build()	Builds H2ProtocolConfig.
H2ProtocolConfigBuilder	enableFrameLogging(String loggerName, LogLevel logLevel, BooleanSupplier logUserData)	Enables a logger for HTTP/2 frames.
H2ProtocolConfigBuilder	flowControlQuantum(int flowControlQuantum)	Provide a hint on the number of bytes that the flow controller will attempt to give to a stream for each allocation (assuming the stream has this much eligible data).
H2ProtocolConfigBuilder	flowControlWindowIncrement(int connectionWindowIncrement)	Increment to apply to Http2Settings.initialWindowSize() for the connection stream.
H2ProtocolConfigBuilder	headersFactory(HttpHeadersFactory headersFactory)	Sets the HttpHeadersFactory to be used for creating HttpHeaders when decoding HTTP messages.
H2ProtocolConfigBuilder	headersSensitivityDetector(BiPredicate<CharSequence,CharSequence> headersSensitivityDetector)	Sets the sensitivity detector to determine if a header name/value pair should be treated as sensitive.
H2ProtocolConfigBuilder	initialSettings(Http2Settings settings)	Sets the initial HTTP/2 Setting to for each h2 connection.
H2ProtocolConfigBuilder	keepAlivePolicy(H2ProtocolConfig.KeepAlivePolicy policy)	Sets the H2ProtocolConfig.KeepAlivePolicy to use.

Methods inherited from class java.lang.Object

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

Method Details

headersFactory

public H2ProtocolConfigBuilder headersFactory(HttpHeadersFactory headersFactory)

Sets the HttpHeadersFactory to be used for creating HttpHeaders when decoding HTTP messages.

Parameters:

headersFactory - HttpHeadersFactory to be used for creating HttpHeaders when decoding HTTP messages

Returns:

this

headersSensitivityDetector

public H2ProtocolConfigBuilder headersSensitivityDetector(BiPredicate<CharSequence,CharSequence> headersSensitivityDetector)

Sets the sensitivity detector to determine if a header name/value pair should be treated as sensitive.

Parameters:

headersSensitivityDetector - the BiPredicate<CharSequence, CharSequence> that returns true if a header <name, value> pair should be treated as sensitive, false otherwise

Returns:

this

enableFrameLogging

public H2ProtocolConfigBuilder enableFrameLogging(String loggerName,
 LogLevel logLevel,
 BooleanSupplier logUserData)

Enables a logger for HTTP/2 frames.

Parameters:

loggerName - provides the logger to log HTTP/2 frames.

logLevel - the level to log HTTP/2 frames.

logUserData - true to include user data (e.g. data, headers, etc.). false to exclude user data and log only network events. This method is invoked for each data object allowing for dynamic behavior.

Returns:

this

keepAlivePolicy

public H2ProtocolConfigBuilder keepAlivePolicy(H2ProtocolConfig.KeepAlivePolicy policy)

Sets the H2ProtocolConfig.KeepAlivePolicy to use.

Parameters:

policy - H2ProtocolConfig.KeepAlivePolicy to use.

Returns:

this

See Also:

• H2KeepAlivePolicies

initialSettings

public H2ProtocolConfigBuilder initialSettings(Http2Settings settings)

Sets the initial HTTP/2 Setting to for each h2 connection.

Parameters:

settings - the initial settings to for each h2 connection.

Returns:

this

See Also:

• Http2SettingsBuilder

flowControlQuantum

public H2ProtocolConfigBuilder flowControlQuantum(int flowControlQuantum)

Provide a hint on the number of bytes that the flow controller will attempt to give to a stream for each allocation (assuming the stream has this much eligible data).

Parameters:

flowControlQuantum - a hint on the number of bytes that the flow controller will attempt to give to a stream for each allocation (assuming the stream has this much eligible data).

Returns:

this

flowControlWindowIncrement

public H2ProtocolConfigBuilder flowControlWindowIncrement(int connectionWindowIncrement)

Increment to apply to Http2Settings.initialWindowSize() for the connection stream. This expands the connection flow control window so a single stream can't consume all the flow control credits.

Parameters:

connectionWindowIncrement - The number of bytes to increment the local flow control window for the connection stream.

Returns:

this

build

public H2ProtocolConfig build()

Builds H2ProtocolConfig.

Returns:

H2ProtocolConfig