BlazeServerBuilder is the component for the builder pattern aggregating different components to finally serve requests.
BlazeServerBuilder is the component for the builder pattern aggregating different components to finally serve requests.
Variables:
- Value Params
- banner:
Pretty log to display on server start. An empty sequence such as Nil disables this
- bufferSize:
Buffer size to use for IO operations
- chunkBufferMaxSize
Size of the buffer that is used when Content-Length header is not specified.
- connectorPoolSize:
Number of worker threads for the new Socket Server Group
- enableWebsockets:
Enables Websocket Support
- executionContext:
Execution Context the underlying blaze futures will be executed upon.
- idleTimeout:
Period of Time a connection can remain idle before the connection is timed out and disconnected. Duration.Inf disables this feature.
- isHttp2Enabled:
Whether or not to enable Http2 Server Features
- isNio2:
Whether or not to use NIO2 or NIO1 Socket Server Group
- maxConnections:
The maximum number of client connections that may be active at any time.
- maxHeadersLen:
Maximum data that composes the headers. If exceeded returns a 400 Bad Request.
- maxRequestLineLength:
Maximum request line to parse If exceeded returns a 400 Bad Request.
- responseHeaderTimeout:
Time from when the request is made until a response line is generated before a 503 response is returned and the
HttpAppis canceled- serviceErrorHandler:
The last resort to recover and generate a response this is necessary to recover totality from the error condition.
- serviceMounts:
The services that are mounted on this server to serve. These services get assembled into a Router with the longer prefix winning.
- socketAddress:
Socket Address the server will be mounted at
- sslBits:
If defined enables secure communication to the server using the sslContext
- Companion
- object
Type members
Types
Value members
Concrete methods
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.
- Value Params
- maxHeadersLen
maximum data that compose headers
- maxRequestLineLen
maximum request line to parse
Configures the server with TLS, using the provided SSLContext and its
default SSLParameters
Configures the server with TLS, using the provided SSLContext and its
default SSLParameters
Deprecated methods
- Deprecated
Inherited methods
Returns an effect that allocates a backend and an F[Unit] to
release it. The returned F waits until the backend is ready
to process requests. The second element of the tuple shuts
down the backend when run.
Returns an effect that allocates a backend and an F[Unit] to
release it. The returned F waits until the backend is ready
to process requests. The second element of the tuple shuts
down the backend when run.
Unlike resource and stream, there is no automatic release of the backend. This function is intended for REPL sessions, tests, and other situations where composing a cats.effect.Resource or fs2.Stream is not tenable. resource or stream is recommended wherever possible.
- Inherited from
- BackendBuilder
Runs the server as a process that never emits. Useful for a server that runs for the rest of the JVM's life.
Runs the server as a process that never emits. Useful for a server that runs for the rest of the JVM's life.
- Inherited from
- ServerBuilder
Runs the server as a Stream that emits only when the terminated signal becomes true. Useful for servers with associated lifetime behaviors.
Runs the server as a Stream that emits only when the terminated signal becomes true. Useful for servers with associated lifetime behaviors.
- Inherited from
- ServerBuilder
Returns the backend as a single-element stream. The stream does not emit until the backend is ready to process requests. The backend is shut down when the stream is finalized.
Returns the backend as a single-element stream. The stream does not emit until the backend is ready to process requests. The backend is shut down when the stream is finalized.
- Inherited from
- BackendBuilder