Packages

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:

Source
BlazeServerBuilder.scala
Linear Supertypes
BlazeBackendBuilder[Server[F]], ServerBuilder[F], BackendBuilder[F, Server[F]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BlazeServerBuilder
  2. BlazeBackendBuilder
  3. ServerBuilder
  4. BackendBuilder
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. 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

  1. type Self = BlazeServerBuilder[F]
    Definition Classes
    BlazeServerBuilder → BlazeBackendBuilder → ServerBuilder

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 BlazeServerBuilder[F] to any2stringadd[BlazeServerBuilder[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BlazeServerBuilder[F], B)
    Implicit
    This member is added by an implicit conversion from BlazeServerBuilder[F] to ArrowAssoc[BlazeServerBuilder[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. implicit val F: ConcurrentEffect[F]
    Attributes
    protected
    Definition Classes
    BlazeServerBuilder → ServerBuilder → BackendBuilder
  7. def allocated: F[(Server[F], F[Unit])]

    Returns an effect that allocates a backend and an F[Unit] to release it.

    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.

    Definition Classes
    BackendBuilder
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. final def bindAny(host: String = defaults.Host): Self
    Definition Classes
    ServerBuilder
  10. final def bindHttp(port: Int = defaults.HttpPort, host: String = defaults.Host): Self
    Definition Classes
    ServerBuilder
  11. final def bindLocal(port: Int): Self
    Definition Classes
    ServerBuilder
  12. def bindSocketAddress(socketAddress: InetSocketAddress): Self
    Definition Classes
    BlazeServerBuilder → ServerBuilder
  13. def channelOption[A](socketOption: SocketOption[A]): Option[A]
    Definition Classes
    BlazeBackendBuilder
  14. val channelOptions: ChannelOptions
    Definition Classes
    BlazeServerBuilder → BlazeBackendBuilder
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  16. def enableHttp2(enabled: Boolean): Self
  17. def ensuring(cond: (BlazeServerBuilder[F]) ⇒ Boolean, msg: ⇒ Any): BlazeServerBuilder[F]
    Implicit
    This member is added by an implicit conversion from BlazeServerBuilder[F] to Ensuring[BlazeServerBuilder[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: (BlazeServerBuilder[F]) ⇒ Boolean): BlazeServerBuilder[F]
    Implicit
    This member is added by an implicit conversion from BlazeServerBuilder[F] to Ensuring[BlazeServerBuilder[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean, msg: ⇒ Any): BlazeServerBuilder[F]
    Implicit
    This member is added by an implicit conversion from BlazeServerBuilder[F] to Ensuring[BlazeServerBuilder[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean): BlazeServerBuilder[F]
    Implicit
    This member is added by an implicit conversion from BlazeServerBuilder[F] to Ensuring[BlazeServerBuilder[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BlazeServerBuilder[F] to StringFormat[BlazeServerBuilder[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  25. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. 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
    BlazeServerBuilder → ServerBuilder → BackendBuilder
  32. 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
  33. final def serveWhile(terminateWhenTrue: Signal[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
  34. def socketKeepAlive: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  35. def socketReceiveBufferSize: Option[Int]
    Definition Classes
    BlazeBackendBuilder
  36. def socketReuseAddress: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  37. def socketSendBufferSize: Option[Int]
    Definition Classes
    BlazeBackendBuilder
  38. def stream: Stream[F, Server[F]]

    Returns the backend as a single-element stream.

    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.

    Definition Classes
    BackendBuilder
  39. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  40. def tcpNoDelay: Option[Boolean]
    Definition Classes
    BlazeBackendBuilder
  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  45. 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
    BlazeServerBuilder → ServerBuilder
  46. def withBufferSize(size: Int): Self
  47. def withChannelOption[A](key: SocketOption[A], value: A): Self
    Definition Classes
    BlazeBackendBuilder
  48. def withChannelOptions(channelOptions: ChannelOptions): BlazeServerBuilder[F]
    Definition Classes
    BlazeServerBuilder → BlazeBackendBuilder
  49. def withChunkBufferMaxSize(chunkBufferMaxSize: Int): BlazeServerBuilder[F]
  50. def withConnectorPoolSize(size: Int): Self
  51. def withDefaultChannelOption[A](key: SocketOption[A]): Self
    Definition Classes
    BlazeBackendBuilder
  52. def withDefaultSocketKeepAlive: Self
    Definition Classes
    BlazeBackendBuilder
  53. def withDefaultSocketReceiveBufferSize: Self
    Definition Classes
    BlazeBackendBuilder
  54. def withDefaultSocketReuseAddress: Self
    Definition Classes
    BlazeBackendBuilder
  55. def withDefaultSocketSendBufferSize: Self
    Definition Classes
    BlazeBackendBuilder
  56. def withDefaultTcpNoDelay: Self
    Definition Classes
    BlazeBackendBuilder
  57. def withExecutionContext(executionContext: ExecutionContext): BlazeServerBuilder[F]
  58. def withHttpApp(httpApp: HttpApp[F]): Self
  59. def withIdleTimeout(idleTimeout: Duration): Self
  60. 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

  61. def withMaxHeadersLength(maxHeadersLength: Int): BlazeServerBuilder[F]
  62. def withMaxRequestLineLength(maxRequestLineLength: Int): BlazeServerBuilder[F]
  63. def withNio2(isNio2: Boolean): Self
  64. def withResponseHeaderTimeout(responseHeaderTimeout: Duration): Self
  65. def withSSL(keyStore: StoreInfo, keyManagerPassword: String, protocol: String = "TLS", trustStore: Option[StoreInfo] = None, clientAuth: SSLClientAuthMode = SSLClientAuthMode.NotRequested): Self
  66. def withSSLContext(sslContext: SSLContext, clientAuth: SSLClientAuthMode = SSLClientAuthMode.NotRequested): Self
  67. def withSelectorThreadFactory(selectorThreadFactory: ThreadFactory): Self
  68. 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
    BlazeServerBuilder → ServerBuilder
  69. def withSocketKeepAlive(socketKeepAlive: Boolean): Self
    Definition Classes
    BlazeBackendBuilder
  70. def withSocketReceiveBufferSize(socketReceiveBufferSize: Int): Self
    Definition Classes
    BlazeBackendBuilder
  71. def withSocketReuseAddress(socketReuseAddress: Boolean): Self
    Definition Classes
    BlazeBackendBuilder
  72. def withSocketSendBufferSize(socketSendBufferSize: Int): Self
    Definition Classes
    BlazeBackendBuilder
  73. def withTcpNoDelay(tcpNoDelay: Boolean): Self
    Definition Classes
    BlazeBackendBuilder
  74. def withWebSockets(enableWebsockets: Boolean): Self
  75. final def withoutBanner: Self

    Disable the banner when the server starts up

    Disable the banner when the server starts up

    Definition Classes
    ServerBuilder
  76. def →[B](y: B): (BlazeServerBuilder[F], B)
    Implicit
    This member is added by an implicit conversion from BlazeServerBuilder[F] to ArrowAssoc[BlazeServerBuilder[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from BlazeBackendBuilder[Server[F]]

Inherited from ServerBuilder[F]

Inherited from BackendBuilder[F, Server[F]]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from BlazeServerBuilder[F] to any2stringadd[BlazeServerBuilder[F]]

Inherited by implicit conversion StringFormat from BlazeServerBuilder[F] to StringFormat[BlazeServerBuilder[F]]

Inherited by implicit conversion Ensuring from BlazeServerBuilder[F] to Ensuring[BlazeServerBuilder[F]]

Inherited by implicit conversion ArrowAssoc from BlazeServerBuilder[F] to ArrowAssoc[BlazeServerBuilder[F]]

Ungrouped