trait Http2ServerSettings extends javadsl.settings.Http2ServerSettings with Http2CommonSettings
- Self Type
- Http2ServerSettingsImpl
- Annotations
- @ApiMayChange() @DoNotInherit()
- Source
- Http2ServerSettings.scala
- Alphabetic
- By Inheritance
- Http2ServerSettings
- Http2CommonSettings
- Http2ServerSettings
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def frameTypeThrottleBurst: Int
- abstract def frameTypeThrottleCost: Int
- abstract def frameTypeThrottleFrameTypes: Set[String]
- abstract def frameTypeThrottleInterval: FiniteDuration
- abstract def incomingConnectionLevelBufferSize: Int
- Definition Classes
- Http2ServerSettings → Http2CommonSettings
- abstract def incomingStreamLevelBufferSize: Int
- Definition Classes
- Http2ServerSettings → Http2CommonSettings
- abstract def logFrames: Boolean
- Definition Classes
- Http2ServerSettings → Http2CommonSettings → Http2ServerSettings
- abstract def maxConcurrentStreams: Int
- Definition Classes
- Http2ServerSettings → Http2CommonSettings
- abstract def maxConnectionAge: Duration
The maximum time a connection is kept open before the server closes it gracefully.
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.Infdisables this mechanism and is the default.- Since
2.0.0
- abstract def maxConnectionAgeGrace: Duration
The time that requests in flight are given to complete after a connection reached maxConnectionAge and the GOAWAY frame was sent.
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.Infdisables the limit, so that the connection is closed only once all requests in flight have completed.- Since
2.0.0
- abstract def maxConnectionAgeJitter: Double
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.
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.
- Since
2.0.0
- abstract def maxFrameSize: Int
The largest frame payload this endpoint accepts, in bytes.
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.
- Definition Classes
- Http2ServerSettings → Http2CommonSettings
- Since
2.0.0
- abstract def maxHeaderListSize: Int
The maximum size of a decoded header list that this endpoint is prepared to accept, in bytes.
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.
- Definition Classes
- Http2ServerSettings → Http2CommonSettings
- Since
1.4.1
- abstract def minCollectStrictEntitySize: Int
- Definition Classes
- Http2ServerSettings → Http2CommonSettings → Http2ServerSettings
- abstract def outgoingControlFrameBufferSize: Int
- Definition Classes
- Http2ServerSettings → Http2CommonSettings
- abstract def pingInterval: FiniteDuration
- Definition Classes
- Http2ServerSettings → Http2CommonSettings
- abstract def pingTimeout: FiniteDuration
- Definition Classes
- Http2ServerSettings → Http2CommonSettings
- abstract def requestEntityChunkSize: Int
- Definition Classes
- Http2ServerSettings → Http2CommonSettings
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from Http2ServerSettings toany2stringadd[Http2ServerSettings] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (Http2ServerSettings, B)
- Implicit
- This member is added by an implicit conversion from Http2ServerSettings toArrowAssoc[Http2ServerSettings] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def ensuring(cond: (Http2ServerSettings) => Boolean, msg: => Any): Http2ServerSettings
- Implicit
- This member is added by an implicit conversion from Http2ServerSettings toEnsuring[Http2ServerSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (Http2ServerSettings) => Boolean): Http2ServerSettings
- Implicit
- This member is added by an implicit conversion from Http2ServerSettings toEnsuring[Http2ServerSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): Http2ServerSettings
- Implicit
- This member is added by an implicit conversion from Http2ServerSettings toEnsuring[Http2ServerSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): Http2ServerSettings
- Implicit
- This member is added by an implicit conversion from Http2ServerSettings toEnsuring[Http2ServerSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def getFrameTypeThrottleBurst(): Int
- Definition Classes
- Http2ServerSettings
- def getFrameTypeThrottleCost(): Int
- Definition Classes
- Http2ServerSettings
- def getFrameTypeThrottleFrameTypes(): Set[String]
- Definition Classes
- Http2ServerSettings
- def getFrameTypeThrottleInterval: Duration
- Definition Classes
- Http2ServerSettings
- def getIncomingConnectionLevelBufferSize: Int
- Definition Classes
- Http2ServerSettings
- def getIncomingStreamLevelBufferSize: Int
- Definition Classes
- Http2ServerSettings
- def getMaxConcurrentStreams: Int
- Definition Classes
- Http2ServerSettings
- def getMaxConnectionAge: Duration
The maximum time a connection is kept open before the server closes it gracefully.
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 getMaxConnectionAgeGrace, 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
ChronoUnit.FOREVER.getDurationrepresents an infinite age, which disables this mechanism and is the default.- Definition Classes
- Http2ServerSettings
- Since
2.0.0
- def getMaxConnectionAgeGrace: Duration
The time that requests in flight are given to complete after a connection reached the maximum connection age and the GOAWAY frame was sent.
The time that requests in flight are given to complete after a connection reached the maximum connection age and the GOAWAY frame was sent. When the grace period expires, the connection is closed even if requests are still in flight. The value
ChronoUnit.FOREVER.getDurationrepresents an infinite grace period, which disables the limit, so that the connection is closed only once all requests in flight have completed.- Definition Classes
- Http2ServerSettings
- Since
2.0.0
- def getMaxConnectionAgeJitter: Double
The jitter applied to the maximum connection age 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.
The jitter applied to the maximum connection age 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.
- Definition Classes
- Http2ServerSettings
- Since
2.0.0
- def getMaxFrameSize: Int
The largest frame payload this endpoint accepts, in bytes.
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.
- Definition Classes
- Http2ServerSettings
- Since
2.0.0
- def getMaxHeaderListSize: Int
The maximum size of a decoded header list that this endpoint is prepared to accept, in bytes.
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.
- Definition Classes
- Http2ServerSettings
- Since
1.4.1
- def getOutgoingControlFrameBufferSize: Int
- Definition Classes
- Http2ServerSettings
- def getPingInterval: Duration
- Definition Classes
- Http2ServerSettings
- def getPingTimeout: Duration
- Definition Classes
- Http2ServerSettings
- def getRequestEntityChunkSize: Int
- Definition Classes
- Http2ServerSettings
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withFrameTypeThrottleBurst(burst: Int): Http2ServerSettingsImpl
- def withFrameTypeThrottleCost(cost: Int): Http2ServerSettingsImpl
- def withFrameTypeThrottleFrameTypes(frameTypes: Set[String]): Http2ServerSettingsImpl
- def withFrameTypeThrottleInterval(interval: FiniteDuration): Http2ServerSettingsImpl
- def withFrameTypeThrottleInterval(interval: Duration): javadsl.settings.Http2ServerSettings
- Definition Classes
- Http2ServerSettings
- def withIncomingConnectionLevelBufferSize(newValue: Int): Http2ServerSettings
- Definition Classes
- Http2ServerSettings → Http2ServerSettings
- def withIncomingStreamLevelBufferSize(newValue: Int): Http2ServerSettings
- Definition Classes
- Http2ServerSettings → Http2ServerSettings
- def withLogFrames(shouldLog: Boolean): Http2ServerSettings
- Definition Classes
- Http2ServerSettings → Http2ServerSettings
- def withMaxConcurrentStreams(newValue: Int): Http2ServerSettings
- Definition Classes
- Http2ServerSettings → Http2ServerSettings
- def withMaxConnectionAge(age: Duration): Http2ServerSettings
- Since
2.0.0
- def withMaxConnectionAge(age: Duration): javadsl.settings.Http2ServerSettings
Pass
ChronoUnit.FOREVER.getDurationto disable the maximum connection age.Pass
ChronoUnit.FOREVER.getDurationto disable the maximum connection age.- Definition Classes
- Http2ServerSettings
- Since
2.0.0
- def withMaxConnectionAgeGrace(grace: Duration): Http2ServerSettings
- Since
2.0.0
- def withMaxConnectionAgeGrace(grace: Duration): javadsl.settings.Http2ServerSettings
Pass
ChronoUnit.FOREVER.getDurationfor an infinite grace period.Pass
ChronoUnit.FOREVER.getDurationfor an infinite grace period.- Definition Classes
- Http2ServerSettings
- Since
2.0.0
- def withMaxConnectionAgeJitter(jitter: Double): Http2ServerSettings
- Definition Classes
- Http2ServerSettings → Http2ServerSettings
- Since
2.0.0
- def withMaxFrameSize(newValue: Int): Http2ServerSettings
- Definition Classes
- Http2ServerSettings → Http2ServerSettings
- Since
2.0.0
- def withMaxHeaderListSize(newValue: Int): Http2ServerSettings
- Definition Classes
- Http2ServerSettings → Http2ServerSettings
- Since
1.4.1
- def withMinCollectStrictEntitySize(newValue: Int): Http2ServerSettings
- Definition Classes
- Http2ServerSettings → Http2ServerSettings
- def withOutgoingControlFrameBufferSize(newValue: Int): Http2ServerSettings
- Definition Classes
- Http2ServerSettings → Http2ServerSettings
- def withPingInterval(time: FiniteDuration): Http2ServerSettings
- def withPingInterval(interval: Duration): javadsl.settings.Http2ServerSettings
- Definition Classes
- Http2ServerSettings
- def withPingTimeout(timeout: FiniteDuration): Http2ServerSettings
- def withPingTimeout(timeout: Duration): javadsl.settings.Http2ServerSettings
- Definition Classes
- Http2ServerSettings
- def withRequestEntityChunkSize(newValue: Int): Http2ServerSettings
- Definition Classes
- Http2ServerSettings → Http2ServerSettings
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Http2ServerSettings toStringFormat[Http2ServerSettings] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (Http2ServerSettings, B)
- Implicit
- This member is added by an implicit conversion from Http2ServerSettings toArrowAssoc[Http2ServerSettings] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.