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

Interface Http2ServerSettings

All Superinterfaces:

Http2CommonSettings, Http2ServerSettings

All Known Implementing Classes:

Http2ServerSettings.Http2ServerSettingsImpl

public interface Http2ServerSettings
extends Http2ServerSettings, Http2CommonSettings

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Http2ServerSettings.Http2ServerSettingsImpl
static class	Http2ServerSettings.Http2ServerSettingsImpl$

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 maxConnectionAge() and the GOAWAY frame was sent.
double	maxConnectionAgeJitter()	The jitter applied to 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()
Http2ServerSettings.Http2ServerSettingsImpl	withFrameTypeThrottleBurst(int burst)
Http2ServerSettings.Http2ServerSettingsImpl	withFrameTypeThrottleCost(int cost)
Http2ServerSettings.Http2ServerSettingsImpl	withFrameTypeThrottleFrameTypes(scala.collection.immutable.Set<String> frameTypes)
Http2ServerSettings.Http2ServerSettingsImpl	withFrameTypeThrottleInterval(scala.concurrent.duration.FiniteDuration interval)
Http2ServerSettings	withIncomingConnectionLevelBufferSize(int newValue)
Http2ServerSettings	withIncomingStreamLevelBufferSize(int newValue)
Http2ServerSettings	withInternalSettings(Http2InternalServerSettings newValue)
Http2ServerSettings	withLogFrames(boolean shouldLog)
Http2ServerSettings	withMaxConcurrentStreams(int newValue)
Http2ServerSettings	withMaxConnectionAge(scala.concurrent.duration.Duration age)
Http2ServerSettings	withMaxConnectionAgeGrace(scala.concurrent.duration.Duration grace)
Http2ServerSettings	withMaxConnectionAgeJitter(double jitter)
Http2ServerSettings	withMaxFrameSize(int newValue)
Http2ServerSettings	withMaxHeaderListSize(int newValue)
Http2ServerSettings	withMinCollectStrictEntitySize(int newValue)
Http2ServerSettings	withOutgoingControlFrameBufferSize(int newValue)
Http2ServerSettings	withPingInterval(scala.concurrent.duration.FiniteDuration time)
Http2ServerSettings	withPingTimeout(scala.concurrent.duration.FiniteDuration timeout)
Http2ServerSettings	withRequestEntityChunkSize(int newValue)

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

Method Details

requestEntityChunkSize

int requestEntityChunkSize()

Specified by:

requestEntityChunkSize in interface Http2CommonSettings

withRequestEntityChunkSize

Http2ServerSettings withRequestEntityChunkSize(int newValue)

Specified by:

withRequestEntityChunkSize in interface Http2ServerSettings

incomingConnectionLevelBufferSize

int incomingConnectionLevelBufferSize()

Specified by:

incomingConnectionLevelBufferSize in interface Http2CommonSettings

withIncomingConnectionLevelBufferSize

Http2ServerSettings withIncomingConnectionLevelBufferSize(int newValue)

Specified by:

withIncomingConnectionLevelBufferSize in interface Http2ServerSettings

incomingStreamLevelBufferSize

int incomingStreamLevelBufferSize()

Specified by:

incomingStreamLevelBufferSize in interface Http2CommonSettings

withIncomingStreamLevelBufferSize

Http2ServerSettings withIncomingStreamLevelBufferSize(int newValue)

Specified by:

withIncomingStreamLevelBufferSize in interface Http2ServerSettings

minCollectStrictEntitySize

int minCollectStrictEntitySize()

Specified by:

minCollectStrictEntitySize in interface Http2CommonSettings

Specified by:

minCollectStrictEntitySize in interface Http2ServerSettings

withMinCollectStrictEntitySize

Http2ServerSettings withMinCollectStrictEntitySize(int newValue)

Specified by:

withMinCollectStrictEntitySize in interface Http2ServerSettings

maxConcurrentStreams

int maxConcurrentStreams()

Specified by:

maxConcurrentStreams in interface Http2CommonSettings

withMaxConcurrentStreams

Http2ServerSettings withMaxConcurrentStreams(int newValue)

Specified by:

withMaxConcurrentStreams in interface Http2ServerSettings

maxHeaderListSize

int maxHeaderListSize()

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

Returns:

(undocumented)

Since:

1.4.1

withMaxHeaderListSize

Http2ServerSettings withMaxHeaderListSize(int newValue)

Specified by:

withMaxHeaderListSize in interface Http2ServerSettings

Parameters:

newValue - (undocumented)

Returns:

(undocumented)

Since:

1.4.1

maxFrameSize

int maxFrameSize()

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

Returns:

(undocumented)

Since:

2.0.0

withMaxFrameSize

Http2ServerSettings withMaxFrameSize(int newValue)

Specified by:

withMaxFrameSize in interface Http2ServerSettings

Parameters:

newValue - (undocumented)

Returns:

(undocumented)

Since:

2.0.0

outgoingControlFrameBufferSize

int outgoingControlFrameBufferSize()

Specified by:

outgoingControlFrameBufferSize in interface Http2CommonSettings

withOutgoingControlFrameBufferSize

Http2ServerSettings withOutgoingControlFrameBufferSize(int newValue)

Specified by:

withOutgoingControlFrameBufferSize in interface Http2ServerSettings

logFrames

boolean logFrames()

Specified by:

logFrames in interface Http2CommonSettings

Specified by:

logFrames in interface Http2ServerSettings

withLogFrames

Http2ServerSettings withLogFrames(boolean shouldLog)

Specified by:

withLogFrames in interface Http2ServerSettings

pingInterval

scala.concurrent.duration.FiniteDuration pingInterval()

Specified by:

pingInterval in interface Http2CommonSettings

withPingInterval

Http2ServerSettings withPingInterval(scala.concurrent.duration.FiniteDuration time)

pingTimeout

scala.concurrent.duration.FiniteDuration pingTimeout()

Specified by:

pingTimeout in interface Http2CommonSettings

withPingTimeout

Http2ServerSettings withPingTimeout(scala.concurrent.duration.FiniteDuration timeout)

maxConnectionAge

scala.concurrent.duration.Duration maxConnectionAge()

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 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.

Returns:

(undocumented)

Since:

2.0.0

withMaxConnectionAge

Http2ServerSettings withMaxConnectionAge(scala.concurrent.duration.Duration age)

Parameters:

age - (undocumented)

Returns:

(undocumented)

Since:

2.0.0

maxConnectionAgeGrace

scala.concurrent.duration.Duration maxConnectionAgeGrace()

The time that requests in flight are given to complete after a connection reached 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.

Returns:

(undocumented)

Since:

2.0.0

withMaxConnectionAgeGrace

Http2ServerSettings withMaxConnectionAgeGrace(scala.concurrent.duration.Duration grace)

Parameters:

grace - (undocumented)

Returns:

(undocumented)

Since:

2.0.0

maxConnectionAgeJitter

double maxConnectionAgeJitter()

The jitter applied to 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.

Returns:

(undocumented)

Since:

2.0.0

withMaxConnectionAgeJitter

Http2ServerSettings withMaxConnectionAgeJitter(double jitter)

Specified by:

withMaxConnectionAgeJitter in interface Http2ServerSettings

Parameters:

jitter - (undocumented)

Returns:

(undocumented)

Since:

2.0.0

frameTypeThrottleFrameTypes

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

withFrameTypeThrottleFrameTypes

Http2ServerSettings.Http2ServerSettingsImpl withFrameTypeThrottleFrameTypes(scala.collection.immutable.Set<String> frameTypes)

frameTypeThrottleCost

int frameTypeThrottleCost()

withFrameTypeThrottleCost

Http2ServerSettings.Http2ServerSettingsImpl withFrameTypeThrottleCost(int cost)

frameTypeThrottleBurst

int frameTypeThrottleBurst()

withFrameTypeThrottleBurst

Http2ServerSettings.Http2ServerSettingsImpl withFrameTypeThrottleBurst(int burst)

frameTypeThrottleInterval

scala.concurrent.duration.FiniteDuration frameTypeThrottleInterval()

withFrameTypeThrottleInterval

Http2ServerSettings.Http2ServerSettingsImpl withFrameTypeThrottleInterval(scala.concurrent.duration.FiniteDuration interval)

internalSettings

scala.Option<Http2InternalServerSettings> internalSettings()

withInternalSettings

Http2ServerSettings withInternalSettings(Http2InternalServerSettings newValue)