Packages

abstract class ServerSettings extends javadsl.settings.ServerSettings

Public API but not intended for subclassing

Self Type
ServerSettingsImpl
Annotations
@DoNotInherit()
Source
ServerSettings.scala
Linear Supertypes
javadsl.settings.ServerSettings, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServerSettings
  2. ServerSettings
  3. AnyRef
  4. Any
Implicitly
  1. by timeoutsShortcut
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def backlog: Int
  2. abstract def defaultHostHeader: Host
  3. abstract def defaultHttpPort: Int
  4. abstract def defaultHttpsPort: Int
  5. abstract def enableHttp2: Boolean

    Configures the Http extension to bind using HTTP/2 if given an pekko.http.scaladsl.HttpsConnectionContext.

    Configures the Http extension to bind using HTTP/2 if given an pekko.http.scaladsl.HttpsConnectionContext. Otherwise binds as plain HTTP.

    Definition Classes
    ServerSettings → ServerSettings
    Since

    1.3.0

  6. abstract def http2Settings: Http2ServerSettings
  7. abstract def logUnencryptedNetworkBytes: Option[Int]
  8. abstract def maxConnections: Int
  9. abstract def parserSettings: ParserSettings
  10. abstract def parsingErrorHandler: String
  11. abstract def pipeliningLimit: Int
  12. abstract def rawRequestUriHeader: Boolean
  13. abstract def remoteAddressAttribute: Boolean
  14. abstract def responseHeaderSizeHint: Int
  15. abstract def serverHeader: Option[Server]
  16. abstract def socketOptions: Seq[SocketOption]
  17. abstract def streamCancellationDelay: FiniteDuration
  18. abstract def terminationDeadlineExceededResponse: HttpResponse
  19. abstract def timeouts: Timeouts
  20. abstract def transparentHeadRequests: Boolean
  21. abstract def verboseErrorMessages: Boolean
  22. abstract def websocketSettings: WebSocketSettings

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 ServerSettings toany2stringadd[ServerSettings] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ServerSettings, B)
    Implicit
    This member is added by an implicit conversion from ServerSettings toArrowAssoc[ServerSettings] 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 bindTimeout: FiniteDuration
    Implicit
    This member is added by an implicit conversion from ServerSettings toTimeouts performed by method timeoutsShortcut in org.apache.pekko.http.scaladsl.settings.ServerSettings.
    Definition Classes
    Timeouts
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  9. def ensuring(cond: (ServerSettings) => Boolean, msg: => Any): ServerSettings
    Implicit
    This member is added by an implicit conversion from ServerSettings toEnsuring[ServerSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (ServerSettings) => Boolean): ServerSettings
    Implicit
    This member is added by an implicit conversion from ServerSettings toEnsuring[ServerSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): ServerSettings
    Implicit
    This member is added by an implicit conversion from ServerSettings toEnsuring[ServerSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): ServerSettings
    Implicit
    This member is added by an implicit conversion from ServerSettings toEnsuring[ServerSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def getBacklog: Int
    Definition Classes
    ServerSettings → ServerSettings
  16. def getBindTimeout: Duration

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from ServerSettings toTimeouts performed by method timeoutsShortcut in org.apache.pekko.http.scaladsl.settings.ServerSettings.
    Definition Classes
    Timeouts
    Since

    2.0.0

  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  18. def getDefaultHostHeader: Host
    Definition Classes
    ServerSettings → ServerSettings
  19. def getDefaultHttpPort: Int
    Definition Classes
    ServerSettings → ServerSettings
  20. def getDefaultHttpsPort: Int
    Definition Classes
    ServerSettings → ServerSettings
  21. def getHttp2Settings: javadsl.settings.Http2ServerSettings
    Definition Classes
    ServerSettings
  22. def getIdleTimeout: Duration

    Java API: an infinite idle timeout is returned as ChronoUnit.FOREVER.getDuration.

    Java API: an infinite idle timeout is returned as ChronoUnit.FOREVER.getDuration.

    Implicit
    This member is added by an implicit conversion from ServerSettings toTimeouts performed by method timeoutsShortcut in org.apache.pekko.http.scaladsl.settings.ServerSettings.
    Definition Classes
    Timeouts
    Since

    2.0.0

  23. def getLingerTimeout: Duration

    Java API: an infinite linger timeout is returned as ChronoUnit.FOREVER.getDuration.

    Java API: an infinite linger timeout is returned as ChronoUnit.FOREVER.getDuration.

    Implicit
    This member is added by an implicit conversion from ServerSettings toTimeouts performed by method timeoutsShortcut in org.apache.pekko.http.scaladsl.settings.ServerSettings.
    Definition Classes
    Timeouts
    Since

    2.0.0

  24. def getLogUnencryptedNetworkBytes: Optional[Int]
    Definition Classes
    ServerSettings → ServerSettings
  25. def getMaxConnections: Int
    Definition Classes
    ServerSettings → ServerSettings
  26. def getParserSettings: javadsl.settings.ParserSettings
    Definition Classes
    ServerSettings → ServerSettings
  27. def getParsingErrorHandler: String
    Definition Classes
    ServerSettings → ServerSettings
  28. def getPipeliningLimit: Int
    Definition Classes
    ServerSettings → ServerSettings
  29. def getRawRequestUriHeader: Boolean
    Definition Classes
    ServerSettings → ServerSettings
  30. def getRemoteAddressAttribute: Boolean
    Definition Classes
    ServerSettings → ServerSettings
  31. def getRequestTimeout: Duration

    Java API: an infinite request timeout is returned as ChronoUnit.FOREVER.getDuration.

    Java API: an infinite request timeout is returned as ChronoUnit.FOREVER.getDuration.

    Implicit
    This member is added by an implicit conversion from ServerSettings toTimeouts performed by method timeoutsShortcut in org.apache.pekko.http.scaladsl.settings.ServerSettings.
    Definition Classes
    Timeouts
    Since

    2.0.0

  32. def getResponseHeaderSizeHint: Int
    Definition Classes
    ServerSettings → ServerSettings
  33. def getServerHeader: Optional[Server]
    Definition Classes
    ServerSettings → ServerSettings
  34. def getSocketOptions: List[SocketOption]
    Definition Classes
    ServerSettings → ServerSettings
  35. def getStreamCancellationDelay: Duration

    In 2.0.0, the return type of this method changed from scala.concurrent.duration.FiniteDuration to java.time.Duration.

    In 2.0.0, the return type of this method changed from scala.concurrent.duration.FiniteDuration to java.time.Duration.

    Definition Classes
    ServerSettings
  36. def getTerminationDeadlineExceededResponse: HttpResponse
    Definition Classes
    ServerSettings → ServerSettings
  37. def getTimeouts: Timeouts
    Definition Classes
    ServerSettings → ServerSettings
  38. def getTransparentHeadRequests: Boolean
    Definition Classes
    ServerSettings → ServerSettings
  39. def getVerboseErrorMessages: Boolean
    Definition Classes
    ServerSettings → ServerSettings
  40. def getWebsocketSettings: WebSocketSettings
    Definition Classes
    ServerSettings → ServerSettings
  41. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  42. def idleTimeout: Duration
    Implicit
    This member is added by an implicit conversion from ServerSettings toTimeouts performed by method timeoutsShortcut in org.apache.pekko.http.scaladsl.settings.ServerSettings.
    Definition Classes
    Timeouts
  43. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  44. def lingerTimeout: Duration
    Implicit
    This member is added by an implicit conversion from ServerSettings toTimeouts performed by method timeoutsShortcut in org.apache.pekko.http.scaladsl.settings.ServerSettings.
    Definition Classes
    Timeouts
  45. def mapHttp2Settings(f: (Http2ServerSettings) => Http2ServerSettings): ServerSettings
  46. def mapParserSettings(f: (ParserSettings) => ParserSettings): ServerSettings
  47. def mapTimeouts(f: (Timeouts) => Timeouts): ServerSettings
  48. def mapWebsocketSettings(f: (WebSocketSettings) => WebSocketSettings): ServerSettings
  49. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  50. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  51. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  52. def requestTimeout: Duration
    Implicit
    This member is added by an implicit conversion from ServerSettings toTimeouts performed by method timeoutsShortcut in org.apache.pekko.http.scaladsl.settings.ServerSettings.
    Definition Classes
    Timeouts
  53. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  54. def toString(): String
    Definition Classes
    AnyRef → Any
  55. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  56. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  57. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  58. def withBacklog(newValue: Int): ServerSettings
    Definition Classes
    ServerSettings → ServerSettings
  59. def withBindTimeout(newValue: Duration): Timeouts

    Java API

    Java API

    Implicit
    This member is added by an implicit conversion from ServerSettings toTimeouts performed by method timeoutsShortcut in org.apache.pekko.http.scaladsl.settings.ServerSettings.
    Definition Classes
    Timeouts → Timeouts
    Since

    2.0.0

  60. def withBindTimeout(newValue: FiniteDuration): Timeouts
    Implicit
    This member is added by an implicit conversion from ServerSettings toTimeouts performed by method timeoutsShortcut in org.apache.pekko.http.scaladsl.settings.ServerSettings.
    Definition Classes
    Timeouts → Timeouts
  61. def withDefaultHostHeader(newValue: Host): ServerSettings
  62. def withDefaultHostHeader(newValue: Host): javadsl.settings.ServerSettings
    Definition Classes
    ServerSettings
  63. def withDefaultHttpPort(newValue: Int): ServerSettings
    Definition Classes
    ServerSettings → ServerSettings
  64. def withDefaultHttpsPort(newValue: Int): ServerSettings
    Definition Classes
    ServerSettings → ServerSettings
  65. def withEnableHttp2(newValue: Boolean): ServerSettings

    Definition Classes
    ServerSettings → ServerSettings
    Since

    1.3.0

  66. def withHttp2Settings(newValue: Http2ServerSettings): ServerSettings
  67. def withHttp2Settings(newValue: javadsl.settings.Http2ServerSettings): javadsl.settings.ServerSettings
    Definition Classes
    ServerSettings
  68. def withIdleTimeout(newValue: Duration): Timeouts

    Java API: use ChronoUnit.FOREVER.getDuration for an infinite idle timeout.

    Java API: use ChronoUnit.FOREVER.getDuration for an infinite idle timeout.

    Implicit
    This member is added by an implicit conversion from ServerSettings toTimeouts performed by method timeoutsShortcut in org.apache.pekko.http.scaladsl.settings.ServerSettings.
    Definition Classes
    Timeouts → Timeouts
    Since

    2.0.0

  69. def withIdleTimeout(newValue: Duration): Timeouts
    Implicit
    This member is added by an implicit conversion from ServerSettings toTimeouts performed by method timeoutsShortcut in org.apache.pekko.http.scaladsl.settings.ServerSettings.
    Definition Classes
    Timeouts → Timeouts
  70. def withLingerTimeout(newValue: Duration): Timeouts

    Java API: use ChronoUnit.FOREVER.getDuration for an infinite linger timeout.

    Java API: use ChronoUnit.FOREVER.getDuration for an infinite linger timeout.

    Implicit
    This member is added by an implicit conversion from ServerSettings toTimeouts performed by method timeoutsShortcut in org.apache.pekko.http.scaladsl.settings.ServerSettings.
    Definition Classes
    Timeouts → Timeouts
    Since

    2.0.0

  71. def withLingerTimeout(newValue: Duration): Timeouts
    Implicit
    This member is added by an implicit conversion from ServerSettings toTimeouts performed by method timeoutsShortcut in org.apache.pekko.http.scaladsl.settings.ServerSettings.
    Definition Classes
    Timeouts → Timeouts
  72. def withLogUnencryptedNetworkBytes(newValue: Option[Int]): ServerSettings
  73. def withLogUnencryptedNetworkBytes(newValue: Optional[Int]): javadsl.settings.ServerSettings
    Definition Classes
    ServerSettings
  74. def withMaxConnections(newValue: Int): ServerSettings
    Definition Classes
    ServerSettings → ServerSettings
  75. def withParserSettings(newValue: ParserSettings): ServerSettings
  76. def withParserSettings(newValue: javadsl.settings.ParserSettings): javadsl.settings.ServerSettings
    Definition Classes
    ServerSettings
  77. def withParsingErrorHandler(newValue: String): ServerSettings
    Definition Classes
    ServerSettings → ServerSettings
  78. def withPipeliningLimit(newValue: Int): ServerSettings
    Definition Classes
    ServerSettings → ServerSettings
  79. def withRawRequestUriHeader(newValue: Boolean): ServerSettings
    Definition Classes
    ServerSettings → ServerSettings
  80. def withRemoteAddressAttribute(newValue: Boolean): ServerSettings
    Definition Classes
    ServerSettings → ServerSettings
  81. def withRequestTimeout(newValue: Duration): Timeouts

    Java API: use ChronoUnit.FOREVER.getDuration for an infinite request timeout.

    Java API: use ChronoUnit.FOREVER.getDuration for an infinite request timeout.

    Implicit
    This member is added by an implicit conversion from ServerSettings toTimeouts performed by method timeoutsShortcut in org.apache.pekko.http.scaladsl.settings.ServerSettings.
    Definition Classes
    Timeouts → Timeouts
    Since

    2.0.0

  82. def withRequestTimeout(newValue: Duration): Timeouts
    Implicit
    This member is added by an implicit conversion from ServerSettings toTimeouts performed by method timeoutsShortcut in org.apache.pekko.http.scaladsl.settings.ServerSettings.
    Definition Classes
    Timeouts → Timeouts
  83. def withResponseHeaderSizeHint(newValue: Int): ServerSettings
    Definition Classes
    ServerSettings → ServerSettings
  84. def withServerHeader(newValue: Option[Server]): ServerSettings
  85. def withServerHeader(newValue: Optional[Server]): javadsl.settings.ServerSettings
    Definition Classes
    ServerSettings
  86. def withSocketOptions(newValue: Seq[SocketOption]): ServerSettings
  87. def withSocketOptions(newValue: Iterable[SocketOption]): ServerSettings
    Definition Classes
    ServerSettings → ServerSettings
  88. def withStreamCancellationDelay(newValue: Duration): ServerSettings

    Java API

    Java API

    Definition Classes
    ServerSettings → ServerSettings
    Since

    2.0.0

  89. def withStreamCancellationDelay(newValue: FiniteDuration): ServerSettings
    Definition Classes
    ServerSettings → ServerSettings
  90. def withTerminationDeadlineExceededResponse(response: HttpResponse): ServerSettings
    Definition Classes
    ServerSettings → ServerSettings
  91. def withTimeouts(newValue: Timeouts): ServerSettings
  92. def withTimeouts(newValue: Timeouts): javadsl.settings.ServerSettings
    Definition Classes
    ServerSettings
  93. def withTransparentHeadRequests(newValue: Boolean): ServerSettings
    Definition Classes
    ServerSettings → ServerSettings
  94. def withVerboseErrorMessages(newValue: Boolean): ServerSettings
    Definition Classes
    ServerSettings → ServerSettings
  95. def withWebsocketSettings(newValue: WebSocketSettings): ServerSettings
  96. def withWebsocketSettings(newValue: javadsl.settings.WebSocketSettings): javadsl.settings.ServerSettings
    Definition Classes
    ServerSettings

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion timeoutsShortcut fromServerSettings to Timeouts

Inherited by implicit conversion any2stringadd fromServerSettings to any2stringadd[ServerSettings]

Inherited by implicit conversion StringFormat fromServerSettings to StringFormat[ServerSettings]

Inherited by implicit conversion Ensuring fromServerSettings to Ensuring[ServerSettings]

Inherited by implicit conversion ArrowAssoc fromServerSettings to ArrowAssoc[ServerSettings]

Ungrouped