final case class HttpServerConfig(address: String = HttpServerConfig.defaultAddress, port: Option[Int] = None, portFile: Option[Path] = None, pathPrefix: Option[String] = None, requestTimeout: FiniteDuration = HttpServerConfig.defaultRequestTimeout) extends Product with Serializable
JSON API HTTP server configuration.
- address
The address to bind the HTTP server to. Defaults to the loopback address.
- port
The port to bind the HTTP server to. If not specified, the port will be dynamically assigned.
- portFile
Optional file to write the port number to after the server starts. This is useful for other processes to discover the port on which the server is running.
- pathPrefix
The path prefix for the HTTP server. If specified, all routes will be prefixed with this path.
- requestTimeout
The timeout for HTTP requests. Defaults to 20 seconds. Increase this value if you expect to handle long-running requests. As the backing server is implemented by Pekko HTTP, this configuration overrides the provided Pekko configuration (pekko.http.server.request-timeout).
- Alphabetic
- By Inheritance
- HttpServerConfig
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new HttpServerConfig(address: String = HttpServerConfig.defaultAddress, port: Option[Int] = None, portFile: Option[Path] = None, pathPrefix: Option[String] = None, requestTimeout: FiniteDuration = HttpServerConfig.defaultRequestTimeout)
- address
The address to bind the HTTP server to. Defaults to the loopback address.
- port
The port to bind the HTTP server to. If not specified, the port will be dynamically assigned.
- portFile
Optional file to write the port number to after the server starts. This is useful for other processes to discover the port on which the server is running.
- pathPrefix
The path prefix for the HTTP server. If specified, all routes will be prefixed with this path.
- requestTimeout
The timeout for HTTP requests. Defaults to 20 seconds. Increase this value if you expect to handle long-running requests. As the backing server is implemented by Pekko HTTP, this configuration overrides the provided Pekko configuration (pekko.http.server.request-timeout).
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val address: String
- 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()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- 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()
- val pathPrefix: Option[String]
- val port: Option[Int]
- val portFile: Option[Path]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val requestTimeout: FiniteDuration
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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])