Trait/Object

org.http4s.server

ServerBuilder

Related Docs: object ServerBuilder | package server

Permalink

trait ServerBuilder[F[_]] extends BackendBuilder[F, Server[F]]

Linear Supertypes
BackendBuilder[F, Server[F]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServerBuilder
  2. BackendBuilder
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Self <: ServerBuilder[F]

    Permalink

Abstract Value Members

  1. implicit abstract def F: Concurrent[F]

    Permalink
    Attributes
    protected
    Definition Classes
    ServerBuilder → BackendBuilder
  2. abstract def bindSocketAddress(socketAddress: InetSocketAddress): Self

    Permalink
  3. abstract def resource: Resource[F, Server[F]]

    Permalink

    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
    ServerBuilder → BackendBuilder
  4. abstract def withBanner(banner: Seq[String]): Self

    Permalink

    Set the banner to display when the server starts up

  5. abstract def withServiceErrorHandler(serviceErrorHandler: ServiceErrorHandler[F]): Self

    Permalink

    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.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def allocated: F[(Server[F], F[Unit])]

    Permalink
    Definition Classes
    BackendBuilder
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. final def bindAny(host: String = defaults.Host): Self

    Permalink
  7. final def bindHttp(port: Int = defaults.HttpPort, host: String = defaults.Host): Self

    Permalink
  8. final def bindLocal(port: Int): Self

    Permalink
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def serve: Stream[F, ExitCode]

    Permalink

    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.

  20. final def serveWhile(terminateWhenTrue: Signal[F, Boolean], exitWith: Ref[F, ExitCode]): Stream[F, ExitCode]

    Permalink

    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.

  21. def stream: Stream[F, Server[F]]

    Permalink
    Definition Classes
    BackendBuilder
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def withoutBanner: Self

    Permalink

    Disable the banner when the server starts up

Inherited from BackendBuilder[F, Server[F]]

Inherited from AnyRef

Inherited from Any

Ungrouped