class BlazeBuilder[F[_]] extends ServerBuilder[F] with IdleTimeoutSupport[F] with SSLKeyStoreSupport[F] with SSLContextSupport[F] with server.WebSocketSupport[F]
BlazeBuilder is the component for the builder pattern aggregating different components to finally serve requests.
Variables:
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0-M2) Use BlazeServerBuilder instead
- Source
- BlazeBuilder.scala
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- BlazeBuilder
- WebSocketSupport
- SSLContextSupport
- SSLKeyStoreSupport
- IdleTimeoutSupport
- ServerBuilder
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- All
Instance Constructors
- new BlazeBuilder(socketAddress: InetSocketAddress, executionContext: ExecutionContext, idleTimeout: Duration, isNio2: Boolean, connectorPoolSize: Int, bufferSize: Int, enableWebSockets: Boolean, sslBits: Option[SSLConfig], isHttp2Enabled: Boolean, maxRequestLineLen: Int, maxHeadersLen: Int, serviceMounts: Vector[ServiceMount[F]], serviceErrorHandler: ServiceErrorHandler[F], banner: Seq[String])(implicit F: ConcurrentEffect[F], timer: Timer[F])
Type Members
-
type
Self = BlazeBuilder[F]
- Definition Classes
- BlazeBuilder → ServerBuilder
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 BlazeBuilder[F] to any2stringadd[BlazeBuilder[F]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (BlazeBuilder[F], B)
- Implicit
- This member is added by an implicit conversion from BlazeBuilder[F] to ArrowAssoc[BlazeBuilder[F]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
implicit
val
F: ConcurrentEffect[F]
- Attributes
- protected
- Definition Classes
- BlazeBuilder → ServerBuilder
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
final
def
bindAny(host: String = DefaultHost): Self
- Definition Classes
- ServerBuilder
-
final
def
bindHttp(port: Int = DefaultHttpPort, host: String = DefaultHost): Self
- Definition Classes
- ServerBuilder
-
final
def
bindLocal(port: Int): Self
- Definition Classes
- ServerBuilder
-
def
bindSocketAddress(socketAddress: InetSocketAddress): Self
- Definition Classes
- BlazeBuilder → ServerBuilder
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
- def enableHttp2(enabled: Boolean): Self
-
def
ensuring(cond: (BlazeBuilder[F]) ⇒ Boolean, msg: ⇒ Any): BlazeBuilder[F]
- Implicit
- This member is added by an implicit conversion from BlazeBuilder[F] to Ensuring[BlazeBuilder[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (BlazeBuilder[F]) ⇒ Boolean): BlazeBuilder[F]
- Implicit
- This member is added by an implicit conversion from BlazeBuilder[F] to Ensuring[BlazeBuilder[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): BlazeBuilder[F]
- Implicit
- This member is added by an implicit conversion from BlazeBuilder[F] to Ensuring[BlazeBuilder[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): BlazeBuilder[F]
- Implicit
- This member is added by an implicit conversion from BlazeBuilder[F] to Ensuring[BlazeBuilder[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from BlazeBuilder[F] to StringFormat[BlazeBuilder[F]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def mountService(service: HttpRoutes[F], prefix: String): Self
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
resource: Resource[F, Server[F]]
Returns a Server resource.
Returns a Server resource. The resource is not acquired until the server is started and ready to accept requests.
- Definition Classes
- BlazeBuilder → ServerBuilder
-
final
def
serve: Stream[F, ExitCode]
Runs the server as a process that never emits.
Runs the server as a process that never emits. Useful for a server that runs for the rest of the JVM's life.
- Definition Classes
- ServerBuilder
-
final
def
serveWhile(terminateWhenTrue: SignallingRef[F, Boolean], exitWith: Ref[F, ExitCode]): Stream[F, ExitCode]
Runs the server as a Stream that emits only when the terminated signal becomes true.
Runs the server as a Stream that emits only when the terminated signal becomes true. Useful for servers with associated lifetime behaviors.
- Definition Classes
- ServerBuilder
-
def
stream: Stream[F, Server[F]]
Returns a Server stream.
Returns a Server stream. The stream does not emit until the server is started and ready to accept requests.
- Definition Classes
- ServerBuilder
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
withBanner(banner: Seq[String]): Self
Set the banner to display when the server starts up
Set the banner to display when the server starts up
- Definition Classes
- BlazeBuilder → ServerBuilder
- def withBufferSize(size: Int): Self
- def withConnectorPoolSize(size: Int): Self
- def withExecutionContext(executionContext: ExecutionContext): BlazeBuilder[F]
-
def
withIdleTimeout(idleTimeout: Duration): Self
- Definition Classes
- BlazeBuilder → IdleTimeoutSupport
-
def
withLengthLimits(maxRequestLineLen: Int = maxRequestLineLen, maxHeadersLen: Int = maxHeadersLen): Self
Configure HTTP parser length limits
Configure HTTP parser length limits
These are to avoid denial of service attacks due to, for example, an infinite request line.
- maxRequestLineLen
maximum request line to parse
- maxHeadersLen
maximum data that compose headers
- def withNio2(isNio2: Boolean): Self
-
def
withSSL(keyStore: StoreInfo, keyManagerPassword: String, protocol: String, trustStore: Option[StoreInfo], clientAuth: Boolean): Self
- Definition Classes
- BlazeBuilder → SSLKeyStoreSupport
-
def
withSSLContext(sslContext: SSLContext, clientAuth: Boolean): Self
- Definition Classes
- BlazeBuilder → SSLContextSupport
-
def
withServiceErrorHandler(serviceErrorHandler: ServiceErrorHandler[F]): Self
Sets the handler for errors thrown invoking the service.
Sets the handler for errors thrown invoking the service. Is not guaranteed to be invoked on errors on the server backend, such as parsing a request or handling a context timeout.
- Definition Classes
- BlazeBuilder → ServerBuilder
-
def
withWebSockets(enableWebsockets: Boolean): Self
- Definition Classes
- BlazeBuilder → WebSocketSupport
-
final
def
withoutBanner: Self
Disable the banner when the server starts up
Disable the banner when the server starts up
- Definition Classes
- ServerBuilder
-
def
→[B](y: B): (BlazeBuilder[F], B)
- Implicit
- This member is added by an implicit conversion from BlazeBuilder[F] to ArrowAssoc[BlazeBuilder[F]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc