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

Interface Http2ClientSettings

All Superinterfaces:

Http2ClientSettings, Http2CommonSettings

All Known Implementing Classes:

Http2ClientSettings.Http2ClientSettingsImpl

public interface Http2ClientSettings
extends Http2ClientSettings, Http2CommonSettings

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Http2ClientSettings.Http2ClientSettingsImpl
static class	Http2ClientSettings.Http2ClientSettingsImpl$

Method Summary

Modifier and Type	Method	Description
scala.concurrent.duration.FiniteDuration	baseConnectionBackoff()
scala.concurrent.duration.FiniteDuration	completionTimeout()
int	incomingConnectionLevelBufferSize()
int	incomingStreamLevelBufferSize()
scala.Option<Http2InternalClientSettings>	internalSettings()
boolean	logFrames()
int	maxConcurrentStreams()
scala.concurrent.duration.FiniteDuration	maxConnectionBackoff()
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	maxPersistentAttempts()
int	minCollectStrictEntitySize()
int	outgoingControlFrameBufferSize()
scala.concurrent.duration.Duration	persistentConnectionMaxAge()	The maximum age of a connection created by managedPersistentHttp2 or managedPersistentHttp2WithPriorKnowledge.
double	persistentConnectionMaxAgeJitter()	The jitter applied to persistentConnectionMaxAge() per connection, as a fraction of the configured age: with the default of 0.1 each connection is retired after between 90% and 110% of the configured age, so that connections that were opened together are not all retired at the same time. 0 disables jitter.
scala.concurrent.duration.FiniteDuration	pingInterval()
scala.concurrent.duration.FiniteDuration	pingTimeout()
int	requestEntityChunkSize()
Http2ClientSettings	withBaseConnectionBackoff(scala.concurrent.duration.FiniteDuration backoff)
Http2ClientSettings	withCompletionTimeout(scala.concurrent.duration.FiniteDuration timeout)
Http2ClientSettings	withIncomingConnectionLevelBufferSize(int newValue)
Http2ClientSettings	withIncomingStreamLevelBufferSize(int newValue)
Http2ClientSettings	withInternalSettings(Http2InternalClientSettings newValue)
Http2ClientSettings	withLogFrames(boolean shouldLog)
Http2ClientSettings	withMaxConcurrentStreams(int newValue)
Http2ClientSettings	withMaxConnectionBackoff(scala.concurrent.duration.FiniteDuration backoff)
Http2ClientSettings	withMaxFrameSize(int newValue)
Http2ClientSettings	withMaxHeaderListSize(int newValue)
Http2ClientSettings	withMaxPersistentAttempts(int max)
Http2ClientSettings	withOutgoingControlFrameBufferSize(int newValue)
Http2ClientSettings	withPersistentConnectionMaxAge(scala.concurrent.duration.Duration maxAge)
Http2ClientSettings	withPersistentConnectionMaxAgeJitter(double jitter)
Http2ClientSettings	withPingInterval(scala.concurrent.duration.FiniteDuration time)
Http2ClientSettings	withPingTimeout(scala.concurrent.duration.FiniteDuration timeout)
Http2ClientSettings	withRequestEntityChunkSize(int newValue)

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

getBaseConnectionBackoff, getCompletionTimeout, getMaxConnectionBackoff, getMaxPersistentAttempts, getPersistentConnectionMaxAge, getPersistentConnectionMaxAgeJitter, getPingInterval, getPingTimeout, withBaseConnectionBackoff, withCompletionTimeout, withMaxConnectionBackoff, withPersistentConnectionMaxAge, withPingInterval, withPingTimeout

Method Details

requestEntityChunkSize

int requestEntityChunkSize()

Specified by:

requestEntityChunkSize in interface Http2ClientSettings

Specified by:

requestEntityChunkSize in interface Http2CommonSettings

withRequestEntityChunkSize

Http2ClientSettings withRequestEntityChunkSize(int newValue)

Specified by:

withRequestEntityChunkSize in interface Http2ClientSettings

incomingConnectionLevelBufferSize

int incomingConnectionLevelBufferSize()

Specified by:

incomingConnectionLevelBufferSize in interface Http2ClientSettings

Specified by:

incomingConnectionLevelBufferSize in interface Http2CommonSettings

withIncomingConnectionLevelBufferSize

Http2ClientSettings withIncomingConnectionLevelBufferSize(int newValue)

Specified by:

withIncomingConnectionLevelBufferSize in interface Http2ClientSettings

incomingStreamLevelBufferSize

int incomingStreamLevelBufferSize()

Specified by:

incomingStreamLevelBufferSize in interface Http2ClientSettings

Specified by:

incomingStreamLevelBufferSize in interface Http2CommonSettings

withIncomingStreamLevelBufferSize

Http2ClientSettings withIncomingStreamLevelBufferSize(int newValue)

Specified by:

withIncomingStreamLevelBufferSize in interface Http2ClientSettings

minCollectStrictEntitySize

int minCollectStrictEntitySize()

Specified by:

minCollectStrictEntitySize in interface Http2CommonSettings

maxConcurrentStreams

int maxConcurrentStreams()

Specified by:

maxConcurrentStreams in interface Http2ClientSettings

Specified by:

maxConcurrentStreams in interface Http2CommonSettings

withMaxConcurrentStreams

Http2ClientSettings withMaxConcurrentStreams(int newValue)

Specified by:

withMaxConcurrentStreams in interface Http2ClientSettings

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 Http2ClientSettings

Specified by:

maxHeaderListSize in interface Http2CommonSettings

Returns:

(undocumented)

Since:

1.4.1

withMaxHeaderListSize

Http2ClientSettings withMaxHeaderListSize(int newValue)

Specified by:

withMaxHeaderListSize in interface Http2ClientSettings

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 Http2ClientSettings

Specified by:

maxFrameSize in interface Http2CommonSettings

Returns:

(undocumented)

Since:

2.0.0

withMaxFrameSize

Http2ClientSettings withMaxFrameSize(int newValue)

Specified by:

withMaxFrameSize in interface Http2ClientSettings

Parameters:

newValue - (undocumented)

Returns:

(undocumented)

Since:

2.0.0

outgoingControlFrameBufferSize

int outgoingControlFrameBufferSize()

Specified by:

outgoingControlFrameBufferSize in interface Http2ClientSettings

Specified by:

outgoingControlFrameBufferSize in interface Http2CommonSettings

withOutgoingControlFrameBufferSize

Http2ClientSettings withOutgoingControlFrameBufferSize(int newValue)

Specified by:

withOutgoingControlFrameBufferSize in interface Http2ClientSettings

logFrames

boolean logFrames()

Specified by:

logFrames in interface Http2ClientSettings

Specified by:

logFrames in interface Http2CommonSettings

withLogFrames

Http2ClientSettings withLogFrames(boolean shouldLog)

Specified by:

withLogFrames in interface Http2ClientSettings

pingInterval

scala.concurrent.duration.FiniteDuration pingInterval()

Specified by:

pingInterval in interface Http2CommonSettings

withPingInterval

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

pingTimeout

scala.concurrent.duration.FiniteDuration pingTimeout()

Specified by:

pingTimeout in interface Http2CommonSettings

withPingTimeout

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

maxPersistentAttempts

int maxPersistentAttempts()

withMaxPersistentAttempts

Http2ClientSettings withMaxPersistentAttempts(int max)

Specified by:

withMaxPersistentAttempts in interface Http2ClientSettings

persistentConnectionMaxAge

scala.concurrent.duration.Duration persistentConnectionMaxAge()

The maximum age of a connection created by managedPersistentHttp2 or managedPersistentHttp2WithPriorKnowledge. When the age of a connection exceeds this value, the connection stops accepting new requests, lets requests that are already in flight complete within completionTimeout(), and is then closed. Later requests are sent on a new connection. The value Duration.Inf disables this mechanism and is the default.

Returns:

(undocumented)

Since:

2.0.0

withPersistentConnectionMaxAge

Http2ClientSettings withPersistentConnectionMaxAge(scala.concurrent.duration.Duration maxAge)

Parameters:

maxAge - (undocumented)

Returns:

(undocumented)

Since:

2.0.0

persistentConnectionMaxAgeJitter

double persistentConnectionMaxAgeJitter()

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

Returns:

(undocumented)

Since:

2.0.0

withPersistentConnectionMaxAgeJitter

Http2ClientSettings withPersistentConnectionMaxAgeJitter(double jitter)

Specified by:

withPersistentConnectionMaxAgeJitter in interface Http2ClientSettings

Parameters:

jitter - (undocumented)

Returns:

(undocumented)

Since:

2.0.0

completionTimeout

scala.concurrent.duration.FiniteDuration completionTimeout()

withCompletionTimeout

Http2ClientSettings withCompletionTimeout(scala.concurrent.duration.FiniteDuration timeout)

baseConnectionBackoff

scala.concurrent.duration.FiniteDuration baseConnectionBackoff()

withBaseConnectionBackoff

Http2ClientSettings withBaseConnectionBackoff(scala.concurrent.duration.FiniteDuration backoff)

maxConnectionBackoff

scala.concurrent.duration.FiniteDuration maxConnectionBackoff()

withMaxConnectionBackoff

Http2ClientSettings withMaxConnectionBackoff(scala.concurrent.duration.FiniteDuration backoff)

internalSettings

scala.Option<Http2InternalClientSettings> internalSettings()

withInternalSettings

Http2ClientSettings withInternalSettings(Http2InternalClientSettings newValue)