Packages

t

org.apache.pekko.http.javadsl.settings

Http2ClientSettings

trait Http2ClientSettings extends AnyRef

Self Type
Http2ClientSettingsImpl
Source
Http2ClientSettings.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Http2ClientSettings
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Http2ClientSettings
  2. AnyRef
  3. 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 incomingConnectionLevelBufferSize: Int
  2. abstract def incomingStreamLevelBufferSize: Int
  3. abstract def logFrames: Boolean
  4. abstract def maxConcurrentStreams: Int
  5. 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.

    Since

    2.0.0

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

    Since

    1.4.1

  7. abstract def outgoingControlFrameBufferSize: Int
  8. abstract def requestEntityChunkSize: Int
  9. abstract def withPersistentConnectionMaxAgeJitter(jitter: Double): Http2ClientSettings

    Since

    2.0.0

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 Http2ClientSettings toany2stringadd[Http2ClientSettings] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Http2ClientSettings, B)
    Implicit
    This member is added by an implicit conversion from Http2ClientSettings toArrowAssoc[Http2ClientSettings] 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: (Http2ClientSettings) => Boolean, msg: => Any): Http2ClientSettings
    Implicit
    This member is added by an implicit conversion from Http2ClientSettings toEnsuring[Http2ClientSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Http2ClientSettings) => Boolean): Http2ClientSettings
    Implicit
    This member is added by an implicit conversion from Http2ClientSettings toEnsuring[Http2ClientSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Http2ClientSettings
    Implicit
    This member is added by an implicit conversion from Http2ClientSettings toEnsuring[Http2ClientSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Http2ClientSettings
    Implicit
    This member is added by an implicit conversion from Http2ClientSettings toEnsuring[Http2ClientSettings] 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. def getBaseConnectionBackoff: Duration
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  16. def getCompletionTimeout: Duration
  17. def getMaxConnectionBackoff: Duration
  18. def getMaxPersistentAttempts: Int
  19. def getPersistentConnectionMaxAge: Duration

    The maximum age of a connection created by managedPersistentHttp2 or managedPersistentHttp2WithPriorKnowledge.

    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 getCompletionTimeout, and is then closed. Later requests are sent on a new connection. The value ChronoUnit.FOREVER.getDuration represents an infinite age, which disables this mechanism and is the default.

    Since

    2.0.0

  20. def getPersistentConnectionMaxAgeJitter: Double

    The jitter applied to the persistent connection maximum age 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.

    The jitter applied to the persistent connection maximum age 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.

    Since

    2.0.0

  21. def getPingInterval: Duration
  22. def getPingTimeout: Duration
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. def withBaseConnectionBackoff(backoff: Duration): Http2ClientSettings
  34. def withCompletionTimeout(timeout: Duration): Http2ClientSettings
  35. def withIncomingConnectionLevelBufferSize(newValue: Int): Http2ClientSettings
  36. def withIncomingStreamLevelBufferSize(newValue: Int): Http2ClientSettings
  37. def withLogFrames(shouldLog: Boolean): Http2ClientSettings
  38. def withMaxConcurrentStreams(newValue: Int): Http2ClientSettings
  39. def withMaxConnectionBackoff(backoff: Duration): Http2ClientSettings
  40. def withMaxFrameSize(newValue: Int): Http2ClientSettings

    Since

    2.0.0

  41. def withMaxHeaderListSize(newValue: Int): Http2ClientSettings

    Since

    1.4.1

  42. def withMaxPersistentAttempts(max: Int): Http2ClientSettings
  43. def withOutgoingControlFrameBufferSize(newValue: Int): Http2ClientSettings
  44. def withPersistentConnectionMaxAge(maxAge: Duration): Http2ClientSettings

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

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

    Since

    2.0.0

  45. def withPingInterval(interval: Duration): Http2ClientSettings
  46. def withPingTimeout(timeout: Duration): Http2ClientSettings
  47. def withRequestEntityChunkSize(newValue: Int): Http2ClientSettings

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 Http2ClientSettings toStringFormat[Http2ClientSettings] 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): (Http2ClientSettings, B)
    Implicit
    This member is added by an implicit conversion from Http2ClientSettings toArrowAssoc[Http2ClientSettings] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromHttp2ClientSettings to any2stringadd[Http2ClientSettings]

Inherited by implicit conversion StringFormat fromHttp2ClientSettings to StringFormat[Http2ClientSettings]

Inherited by implicit conversion Ensuring fromHttp2ClientSettings to Ensuring[Http2ClientSettings]

Inherited by implicit conversion ArrowAssoc fromHttp2ClientSettings to ArrowAssoc[Http2ClientSettings]

Ungrouped