Package org.apache.pekko.http.scaladsl.settings

Class Http2ServerSettings.Http2ServerSettingsImpl

java.lang.Object

org.apache.pekko.http.scaladsl.settings.Http2ServerSettings.Http2ServerSettingsImpl

All Implemented Interfaces:

Serializable, Http2ServerSettings, Http2CommonSettings, Http2ServerSettings, scala.Equals, scala.Product

Enclosing interface:

Http2ServerSettings

public static class Http2ServerSettings.Http2ServerSettingsImpl
extends Object
implements Http2ServerSettings, scala.Product, Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pekko.http.scaladsl.settings.Http2ServerSettings

Http2ServerSettings.Http2ServerSettingsImpl, Http2ServerSettings.Http2ServerSettingsImpl$

Constructor Summary

Constructors

Constructor

Description

Http2ServerSettingsImpl(int maxConcurrentStreams, int maxHeaderListSize, int maxFrameSize, int requestEntityChunkSize, int incomingConnectionLevelBufferSize, int incomingStreamLevelBufferSize, int minCollectStrictEntitySize, int outgoingControlFrameBufferSize, boolean logFrames, scala.concurrent.duration.FiniteDuration pingInterval, scala.concurrent.duration.FiniteDuration pingTimeout, scala.concurrent.duration.Duration maxConnectionAge, scala.concurrent.duration.Duration maxConnectionAgeGrace, double maxConnectionAgeJitter, scala.collection.immutable.Set<String> frameTypeThrottleFrameTypes, int frameTypeThrottleCost, int frameTypeThrottleBurst, scala.concurrent.duration.FiniteDuration frameTypeThrottleInterval, scala.Option<Http2InternalServerSettings> internalSettings)

Method Summary

Modifier and Type	Method	Description
int	frameTypeThrottleBurst()
int	frameTypeThrottleCost()
scala.collection.immutable.Set<String>	frameTypeThrottleFrameTypes()
scala.concurrent.duration.FiniteDuration	frameTypeThrottleInterval()
int	incomingConnectionLevelBufferSize()
int	incomingStreamLevelBufferSize()
scala.Option<Http2InternalServerSettings>	internalSettings()
boolean	logFrames()
int	maxConcurrentStreams()
scala.concurrent.duration.Duration	maxConnectionAge()	The maximum time a connection is kept open before the server closes it gracefully.
scala.concurrent.duration.Duration	maxConnectionAgeGrace()	The time that requests in flight are given to complete after a connection reached Http2ServerSettings.maxConnectionAge() and the GOAWAY frame was sent.
double	maxConnectionAgeJitter()	The jitter applied to Http2ServerSettings.maxConnectionAge() per connection, as a fraction of the configured age: with the default of 0.1 each connection is closed after between 90% and 110% of the configured age, so that connections that were opened together are not all closed at the same time. 0 disables jitter.
int	maxFrameSize()	The largest frame payload this endpoint accepts, in bytes.
int	maxHeaderListSize()	The maximum size of a decoded header list that this endpoint is prepared to accept, in bytes.
int	minCollectStrictEntitySize()
int	outgoingControlFrameBufferSize()
scala.concurrent.duration.FiniteDuration	pingInterval()
scala.concurrent.duration.FiniteDuration	pingTimeout()
int	requestEntityChunkSize()

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface org.apache.pekko.http.javadsl.settings.Http2ServerSettings

getFrameTypeThrottleBurst, getFrameTypeThrottleCost, getFrameTypeThrottleFrameTypes, getFrameTypeThrottleInterval, getIncomingConnectionLevelBufferSize, getIncomingStreamLevelBufferSize, getMaxConcurrentStreams, getMaxConnectionAge, getMaxConnectionAgeGrace, getMaxConnectionAgeJitter, getMaxFrameSize, getMaxHeaderListSize, getOutgoingControlFrameBufferSize, getPingInterval, getPingTimeout, getRequestEntityChunkSize, withFrameTypeThrottleInterval, withMaxConnectionAge, withMaxConnectionAgeGrace, withPingInterval, withPingTimeout

Methods inherited from interface org.apache.pekko.http.scaladsl.settings.Http2ServerSettings

withFrameTypeThrottleBurst, withFrameTypeThrottleCost, withFrameTypeThrottleFrameTypes, withFrameTypeThrottleInterval, withIncomingConnectionLevelBufferSize, withIncomingStreamLevelBufferSize, withInternalSettings, withLogFrames, withMaxConcurrentStreams, withMaxConnectionAge, withMaxConnectionAgeGrace, withMaxConnectionAgeJitter, withMaxFrameSize, withMaxHeaderListSize, withMinCollectStrictEntitySize, withOutgoingControlFrameBufferSize, withPingInterval, withPingTimeout, withRequestEntityChunkSize

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Constructor Details

Http2ServerSettingsImpl

public Http2ServerSettingsImpl(int maxConcurrentStreams,
 int maxHeaderListSize,
 int maxFrameSize,
 int requestEntityChunkSize,
 int incomingConnectionLevelBufferSize,
 int incomingStreamLevelBufferSize,
 int minCollectStrictEntitySize,
 int outgoingControlFrameBufferSize,
 boolean logFrames,
 scala.concurrent.duration.FiniteDuration pingInterval,
 scala.concurrent.duration.FiniteDuration pingTimeout,
 scala.concurrent.duration.Duration maxConnectionAge,
 scala.concurrent.duration.Duration maxConnectionAgeGrace,
 double maxConnectionAgeJitter,
 scala.collection.immutable.Set<String> frameTypeThrottleFrameTypes,
 int frameTypeThrottleCost,
 int frameTypeThrottleBurst,
 scala.concurrent.duration.FiniteDuration frameTypeThrottleInterval,
 scala.Option<Http2InternalServerSettings> internalSettings)

Method Details

maxConcurrentStreams

public int maxConcurrentStreams()

Specified by:

maxConcurrentStreams in interface Http2CommonSettings

Specified by:

maxConcurrentStreams in interface Http2ServerSettings

maxHeaderListSize

public int maxHeaderListSize()

Description copied from interface: Http2ServerSettings

The maximum size of a decoded header list that this endpoint is prepared to accept, in bytes. The value is advertised to the peer via SETTINGS_MAX_HEADER_LIST_SIZE and the same limit is applied to the accumulated header block fragments of a HEADERS frame and its CONTINUATION frames.

Specified by:

maxHeaderListSize in interface Http2CommonSettings

Specified by:

maxHeaderListSize in interface Http2ServerSettings

Returns:

(undocumented)

maxFrameSize

public int maxFrameSize()

Description copied from interface: Http2ServerSettings

The largest frame payload this endpoint accepts, in bytes. A larger incoming frame is rejected with a FRAME_SIZE_ERROR on its frame header, before the payload is buffered. No larger SETTINGS_MAX_FRAME_SIZE is advertised, so a peer that follows the spec keeps to the 16 KiB default and the extra room is leniency for peers that do not. RFC 9113, section 4.2 constrains it to be between 16 KiB and 16 MiB - 1.

Specified by:

maxFrameSize in interface Http2CommonSettings

Specified by:

maxFrameSize in interface Http2ServerSettings

Returns:

(undocumented)

requestEntityChunkSize

public int requestEntityChunkSize()

Specified by:

requestEntityChunkSize in interface Http2CommonSettings

Specified by:

requestEntityChunkSize in interface Http2ServerSettings

incomingConnectionLevelBufferSize

public int incomingConnectionLevelBufferSize()

Specified by:

incomingConnectionLevelBufferSize in interface Http2CommonSettings

Specified by:

incomingConnectionLevelBufferSize in interface Http2ServerSettings

incomingStreamLevelBufferSize

public int incomingStreamLevelBufferSize()

Specified by:

incomingStreamLevelBufferSize in interface Http2CommonSettings

Specified by:

incomingStreamLevelBufferSize in interface Http2ServerSettings

minCollectStrictEntitySize

public int minCollectStrictEntitySize()

Specified by:

minCollectStrictEntitySize in interface Http2CommonSettings

Specified by:

minCollectStrictEntitySize in interface Http2ServerSettings

Specified by:

minCollectStrictEntitySize in interface Http2ServerSettings

outgoingControlFrameBufferSize

public int outgoingControlFrameBufferSize()

Specified by:

outgoingControlFrameBufferSize in interface Http2CommonSettings

Specified by:

outgoingControlFrameBufferSize in interface Http2ServerSettings

logFrames

public boolean logFrames()

Specified by:

logFrames in interface Http2CommonSettings

Specified by:

logFrames in interface Http2ServerSettings

Specified by:

logFrames in interface Http2ServerSettings

pingInterval

public scala.concurrent.duration.FiniteDuration pingInterval()

Specified by:

pingInterval in interface Http2CommonSettings

Specified by:

pingInterval in interface Http2ServerSettings

pingTimeout

public scala.concurrent.duration.FiniteDuration pingTimeout()

Specified by:

pingTimeout in interface Http2CommonSettings

Specified by:

pingTimeout in interface Http2ServerSettings

maxConnectionAge

public scala.concurrent.duration.Duration maxConnectionAge()

Description copied from interface: Http2ServerSettings

The maximum time a connection is kept open before the server closes it gracefully. When the age of a connection exceeds this value, the server sends a GOAWAY frame, lets requests that are already in flight complete within Http2ServerSettings.maxConnectionAgeGrace(), and then closes the connection. If the connection is already being terminated when its age expires, for example because the server binding is being terminated, the expiry has no effect and the termination in progress keeps its own deadline. The value Duration.Inf disables this mechanism and is the default.

Specified by:

maxConnectionAge in interface Http2ServerSettings

Returns:

(undocumented)

maxConnectionAgeGrace

public scala.concurrent.duration.Duration maxConnectionAgeGrace()

Description copied from interface: Http2ServerSettings

The time that requests in flight are given to complete after a connection reached Http2ServerSettings.maxConnectionAge() and the GOAWAY frame was sent. When the grace period expires, the connection is closed even if requests are still in flight. The value Duration.Inf disables the limit, so that the connection is closed only once all requests in flight have completed.

Specified by:

maxConnectionAgeGrace in interface Http2ServerSettings

Returns:

(undocumented)

maxConnectionAgeJitter

public double maxConnectionAgeJitter()

Description copied from interface: Http2ServerSettings

The jitter applied to Http2ServerSettings.maxConnectionAge() per connection, as a fraction of the configured age: with the default of 0.1 each connection is closed after between 90% and 110% of the configured age, so that connections that were opened together are not all closed at the same time. 0 disables jitter.

Specified by:

maxConnectionAgeJitter in interface Http2ServerSettings

Returns:

(undocumented)

frameTypeThrottleFrameTypes

public scala.collection.immutable.Set<String> frameTypeThrottleFrameTypes()

Specified by:

frameTypeThrottleFrameTypes in interface Http2ServerSettings

frameTypeThrottleCost

public int frameTypeThrottleCost()

Specified by:

frameTypeThrottleCost in interface Http2ServerSettings

frameTypeThrottleBurst

public int frameTypeThrottleBurst()

Specified by:

frameTypeThrottleBurst in interface Http2ServerSettings

frameTypeThrottleInterval

public scala.concurrent.duration.FiniteDuration frameTypeThrottleInterval()

Specified by:

frameTypeThrottleInterval in interface Http2ServerSettings

internalSettings

public scala.Option<Http2InternalServerSettings> internalSettings()

Specified by:

internalSettings in interface Http2ServerSettings