Packages

trait Http2ServerSettings extends javadsl.settings.Http2ServerSettings with Http2CommonSettings

Self Type
Http2ServerSettingsImpl
Annotations
@ApiMayChange() @DoNotInherit()
Source
Http2ServerSettings.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Http2ServerSettings
  2. Http2CommonSettings
  3. Http2ServerSettings
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def frameTypeThrottleBurst: Int
  2. abstract def frameTypeThrottleCost: Int
  3. abstract def frameTypeThrottleFrameTypes: Set[String]
  4. abstract def frameTypeThrottleInterval: FiniteDuration
  5. abstract def incomingConnectionLevelBufferSize: Int
    Definition Classes
    Http2ServerSettings → Http2CommonSettings
  6. abstract def incomingStreamLevelBufferSize: Int
    Definition Classes
    Http2ServerSettings → Http2CommonSettings
  7. abstract def logFrames: Boolean
    Definition Classes
    Http2ServerSettings → Http2CommonSettings → Http2ServerSettings
  8. abstract def maxConcurrentStreams: Int
    Definition Classes
    Http2ServerSettings → Http2CommonSettings
  9. 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.Inf disables this mechanism and is the default.

    Since

    2.0.0

  10. 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.Inf disables the limit, so that the connection is closed only once all requests in flight have completed.

    Since

    2.0.0

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

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

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

  14. abstract def minCollectStrictEntitySize: Int
    Definition Classes
    Http2ServerSettings → Http2CommonSettings → Http2ServerSettings
  15. abstract def outgoingControlFrameBufferSize: Int
    Definition Classes
    Http2ServerSettings → Http2CommonSettings
  16. abstract def pingInterval: FiniteDuration
    Definition Classes
    Http2ServerSettings → Http2CommonSettings
  17. abstract def pingTimeout: FiniteDuration
    Definition Classes
    Http2ServerSettings → Http2CommonSettings
  18. abstract def requestEntityChunkSize: Int
    Definition Classes
    Http2ServerSettings → Http2CommonSettings

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. 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
  4. 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()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. 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
  9. 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
  10. 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
  11. 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
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. def getFrameTypeThrottleBurst(): Int
    Definition Classes
    Http2ServerSettings
  16. def getFrameTypeThrottleCost(): Int
    Definition Classes
    Http2ServerSettings
  17. def getFrameTypeThrottleFrameTypes(): Set[String]
    Definition Classes
    Http2ServerSettings
  18. def getFrameTypeThrottleInterval: Duration
    Definition Classes
    Http2ServerSettings
  19. def getIncomingConnectionLevelBufferSize: Int
    Definition Classes
    Http2ServerSettings
  20. def getIncomingStreamLevelBufferSize: Int
    Definition Classes
    Http2ServerSettings
  21. def getMaxConcurrentStreams: Int
    Definition Classes
    Http2ServerSettings
  22. 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.getDuration represents an infinite age, which disables this mechanism and is the default.

    Definition Classes
    Http2ServerSettings
    Since

    2.0.0

  23. 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.getDuration represents 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

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

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

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

  27. def getOutgoingControlFrameBufferSize: Int
    Definition Classes
    Http2ServerSettings
  28. def getPingInterval: Duration
    Definition Classes
    Http2ServerSettings
  29. def getPingTimeout: Duration
    Definition Classes
    Http2ServerSettings
  30. def getRequestEntityChunkSize: Int
    Definition Classes
    Http2ServerSettings
  31. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  36. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  37. def toString(): String
    Definition Classes
    AnyRef → Any
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. def withFrameTypeThrottleBurst(burst: Int): Http2ServerSettingsImpl
  42. def withFrameTypeThrottleCost(cost: Int): Http2ServerSettingsImpl
  43. def withFrameTypeThrottleFrameTypes(frameTypes: Set[String]): Http2ServerSettingsImpl
  44. def withFrameTypeThrottleInterval(interval: FiniteDuration): Http2ServerSettingsImpl
  45. def withFrameTypeThrottleInterval(interval: Duration): javadsl.settings.Http2ServerSettings
    Definition Classes
    Http2ServerSettings
  46. def withIncomingConnectionLevelBufferSize(newValue: Int): Http2ServerSettings
  47. def withIncomingStreamLevelBufferSize(newValue: Int): Http2ServerSettings
  48. def withLogFrames(shouldLog: Boolean): Http2ServerSettings
  49. def withMaxConcurrentStreams(newValue: Int): Http2ServerSettings
  50. def withMaxConnectionAge(age: Duration): Http2ServerSettings

    Since

    2.0.0

  51. def withMaxConnectionAge(age: Duration): javadsl.settings.Http2ServerSettings

    Pass ChronoUnit.FOREVER.getDuration to disable the maximum connection age.

    Pass ChronoUnit.FOREVER.getDuration to disable the maximum connection age.

    Definition Classes
    Http2ServerSettings
    Since

    2.0.0

  52. def withMaxConnectionAgeGrace(grace: Duration): Http2ServerSettings

    Since

    2.0.0

  53. def withMaxConnectionAgeGrace(grace: Duration): javadsl.settings.Http2ServerSettings

    Pass ChronoUnit.FOREVER.getDuration for an infinite grace period.

    Pass ChronoUnit.FOREVER.getDuration for an infinite grace period.

    Definition Classes
    Http2ServerSettings
    Since

    2.0.0

  54. def withMaxConnectionAgeJitter(jitter: Double): Http2ServerSettings

    Definition Classes
    Http2ServerSettings → Http2ServerSettings
    Since

    2.0.0

  55. def withMaxFrameSize(newValue: Int): Http2ServerSettings

    Definition Classes
    Http2ServerSettings → Http2ServerSettings
    Since

    2.0.0

  56. def withMaxHeaderListSize(newValue: Int): Http2ServerSettings

    Definition Classes
    Http2ServerSettings → Http2ServerSettings
    Since

    1.4.1

  57. def withMinCollectStrictEntitySize(newValue: Int): Http2ServerSettings
  58. def withOutgoingControlFrameBufferSize(newValue: Int): Http2ServerSettings
  59. def withPingInterval(time: FiniteDuration): Http2ServerSettings
  60. def withPingInterval(interval: Duration): javadsl.settings.Http2ServerSettings
    Definition Classes
    Http2ServerSettings
  61. def withPingTimeout(timeout: FiniteDuration): Http2ServerSettings
  62. def withPingTimeout(timeout: Duration): javadsl.settings.Http2ServerSettings
    Definition Classes
    Http2ServerSettings
  63. def withRequestEntityChunkSize(newValue: Int): Http2ServerSettings

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. 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 of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

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

Inherited from Http2CommonSettings

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromHttp2ServerSettings to any2stringadd[Http2ServerSettings]

Inherited by implicit conversion StringFormat fromHttp2ServerSettings to StringFormat[Http2ServerSettings]

Inherited by implicit conversion Ensuring fromHttp2ServerSettings to Ensuring[Http2ServerSettings]

Inherited by implicit conversion ArrowAssoc fromHttp2ServerSettings to ArrowAssoc[Http2ServerSettings]

Ungrouped