class BlazeServerBuilder[F[_]] extends ServerBuilder[F] with BlazeBackendBuilder[Server[F]]
BlazeBuilder is the component for the builder pattern aggregating different components to finally serve requests.
Variables:
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- BlazeServerBuilder
- BlazeBackendBuilder
- ServerBuilder
- BackendBuilder
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Instance Constructors
-
new
BlazeServerBuilder(socketAddress: InetSocketAddress, executionContext: ExecutionContext, responseHeaderTimeout: Duration, idleTimeout: Duration, isNio2: Boolean, connectorPoolSize: Int, bufferSize: Int, selectorThreadFactory: ThreadFactory, enableWebSockets: Boolean, sslBits: Option[SSLConfig], isHttp2Enabled: Boolean, maxRequestLineLen: Int, maxHeadersLen: Int, chunkBufferMaxSize: Int, httpApp: HttpApp[F], serviceErrorHandler: ServiceErrorHandler[F], banner: Seq[String], channelOptions: ChannelOptions)(implicit F: ConcurrentEffect[F], timer: Timer[F])
- chunkBufferMaxSize
Size of the buffer that is used when Content-Length header is not specified.
Type Members
-
type
Self = BlazeServerBuilder[F]
- Definition Classes
- BlazeServerBuilder → BlazeBackendBuilder → ServerBuilder
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
-
implicit
val
F: ConcurrentEffect[F]
- Attributes
- protected
- Definition Classes
- BlazeServerBuilder → ServerBuilder → BackendBuilder
-
def
allocated: F[(Server[F], F[Unit])]
- Definition Classes
- BackendBuilder
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
final
def
bindAny(host: String): Self
- Definition Classes
- ServerBuilder
-
final
def
bindHttp(port: Int, host: String): Self
- Definition Classes
- ServerBuilder
-
final
def
bindLocal(port: Int): Self
- Definition Classes
- ServerBuilder
-
def
bindSocketAddress(socketAddress: InetSocketAddress): Self
- Definition Classes
- BlazeServerBuilder → ServerBuilder
-
def
channelOption[A](socketOption: SocketOption[A]): Option[A]
- Definition Classes
- BlazeBackendBuilder
-
val
channelOptions: ChannelOptions
- Definition Classes
- BlazeServerBuilder → BlazeBackendBuilder
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def enableHttp2(enabled: Boolean): Self
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
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
-
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]]
- Definition Classes
- BlazeServerBuilder → ServerBuilder → BackendBuilder
-
final
def
serve: Stream[F, ExitCode]
- Definition Classes
- ServerBuilder
-
final
def
serveWhile(terminateWhenTrue: Signal[F, Boolean], exitWith: Ref[F, ExitCode]): Stream[F, ExitCode]
- Definition Classes
- ServerBuilder
-
def
socketKeepAlive: Option[Boolean]
- Definition Classes
- BlazeBackendBuilder
-
def
socketReceiveBufferSize: Option[Int]
- Definition Classes
- BlazeBackendBuilder
-
def
socketReuseAddress: Option[Boolean]
- Definition Classes
- BlazeBackendBuilder
-
def
socketSendBufferSize: Option[Int]
- Definition Classes
- BlazeBackendBuilder
-
def
stream: Stream[F, Server[F]]
- Definition Classes
- BackendBuilder
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
tcpNoDelay: Option[Boolean]
- Definition Classes
- BlazeBackendBuilder
-
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
- @throws( ... ) @native()
-
def
withBanner(banner: Seq[String]): Self
- Definition Classes
- BlazeServerBuilder → ServerBuilder
- def withBufferSize(size: Int): Self
-
def
withChannelOption[A](key: SocketOption[A], value: A): Self
- Definition Classes
- BlazeBackendBuilder
-
def
withChannelOptions(channelOptions: ChannelOptions): BlazeServerBuilder[F]
- Definition Classes
- BlazeServerBuilder → BlazeBackendBuilder
- def withChunkBufferMaxSize(chunkBufferMaxSize: Int): BlazeServerBuilder[F]
- def withConnectorPoolSize(size: Int): Self
-
def
withDefaultChannelOption[A](key: SocketOption[A]): Self
- Definition Classes
- BlazeBackendBuilder
-
def
withDefaultSocketKeepAlive: Self
- Definition Classes
- BlazeBackendBuilder
-
def
withDefaultSocketReceiveBufferSize: Self
- Definition Classes
- BlazeBackendBuilder
-
def
withDefaultSocketReuseAddress: Self
- Definition Classes
- BlazeBackendBuilder
-
def
withDefaultSocketSendBufferSize: Self
- Definition Classes
- BlazeBackendBuilder
-
def
withDefaultTcpNoDelay: Self
- Definition Classes
- BlazeBackendBuilder
- def withExecutionContext(executionContext: ExecutionContext): BlazeServerBuilder[F]
- def withHttpApp(httpApp: HttpApp[F]): Self
- def withIdleTimeout(idleTimeout: Duration): Self
-
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 withMaxHeadersLength(maxHeadersLength: Int): BlazeServerBuilder[F]
- def withMaxRequestLineLength(maxRequestLineLength: Int): BlazeServerBuilder[F]
- def withNio2(isNio2: Boolean): Self
- def withResponseHeaderTimeout(responseHeaderTimeout: Duration): Self
- def withSSL(keyStore: StoreInfo, keyManagerPassword: String, protocol: String = "TLS", trustStore: Option[StoreInfo] = None, clientAuth: SSLClientAuthMode = SSLClientAuthMode.NotRequested): Self
- def withSSLContext(sslContext: SSLContext, clientAuth: SSLClientAuthMode = SSLClientAuthMode.NotRequested): Self
- def withSelectorThreadFactory(selectorThreadFactory: ThreadFactory): Self
-
def
withServiceErrorHandler(serviceErrorHandler: ServiceErrorHandler[F]): Self
- Definition Classes
- BlazeServerBuilder → ServerBuilder
-
def
withSocketKeepAlive(socketKeepAlive: Boolean): Self
- Definition Classes
- BlazeBackendBuilder
-
def
withSocketReceiveBufferSize(socketReceiveBufferSize: Int): Self
- Definition Classes
- BlazeBackendBuilder
-
def
withSocketReuseAddress(socketReuseAddress: Boolean): Self
- Definition Classes
- BlazeBackendBuilder
-
def
withSocketSendBufferSize(socketSendBufferSize: Int): Self
- Definition Classes
- BlazeBackendBuilder
-
def
withTcpNoDelay(tcpNoDelay: Boolean): Self
- Definition Classes
- BlazeBackendBuilder
- def withWebSockets(enableWebsockets: Boolean): Self
-
final
def
withoutBanner: Self
- Definition Classes
- ServerBuilder