Class/Object

fm.http.server

ControlHandler

Related Docs: object ControlHandler | package server

Permalink

final case class ControlHandler(server: HttpServer, authKey: String) extends DefaultRequestRouter with Logging with Product with Serializable

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ControlHandler
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Logging
  7. DefaultRequestRouter
  8. RequestRouterAndHandler
  9. RequestHandler
  10. RequestRouterBase
  11. RequestRouter
  12. WithFilter
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ControlHandler(server: HttpServer, authKey: String)

    Permalink

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. final def afterShutdown(): Unit

    Permalink

    Called once web server shutdown is completed -- Should be idempotent

    Called once web server shutdown is completed -- Should be idempotent

    Definition Classes
    RequestRouterBaseRequestRouter
  5. def afterShutdownImpl(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    RequestRouterBase
  6. final def afterStartup(): Unit

    Permalink

    Called after the web server is running but before ping is enabled -- Should be idempotent

    Called after the web server is running but before ping is enabled -- Should be idempotent

    Definition Classes
    RequestRouterBaseRequestRouter
  7. def afterStartupImpl(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    RequestRouterBase
  8. final def apply(request: Request)(implicit executor: ExecutionContext): Future[Response]

    Permalink
    Definition Classes
    DefaultRequestRouterRequestHandler
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. val authKey: String

    Permalink
  11. final def beforeShutdown(): Unit

    Permalink

    Called when web server shutdown is requested but before actually shutting down -- Should be idempotent

    Called when web server shutdown is requested but before actually shutting down -- Should be idempotent

    Definition Classes
    RequestRouterBaseRequestRouter
  12. def beforeShutdownImpl(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    RequestRouterBase
  13. final def beforeStartup(): Unit

    Permalink

    Called before the web server starts up -- Should be idempotent

    Called before the web server starts up -- Should be idempotent

    Definition Classes
    RequestRouterBaseRequestRouter
  14. def beforeStartupImpl(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    RequestRouterBase
  15. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. var enabled: Boolean

    Permalink

    This controls whether a "GET /_ping" returns a "200 OK" or a "503 Service Unavailable" response

  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. val handler: PartialFunction[Request, Future[Response]]

    Permalink
    Attributes
    protected
    Definition Classes
    ControlHandlerDefaultRequestRouter
  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  23. final def lookup(request: Request): Option[RequestHandler]

    Permalink

    Given a request lookup a RequestHandler that can satisfy it

    Given a request lookup a RequestHandler that can satisfy it

    Definition Classes
    DefaultRequestRouterRequestRouter
  24. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  27. final def orElse(that: RequestRouter): RequestRouter

    Permalink

    If this router doesn't match the request then try that router

    If this router doesn't match the request then try that router

    Definition Classes
    RequestRouter
  28. val server: HttpServer

    Permalink
  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  30. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def withDefaultHandler(handler: RequestHandler): RequestRouter

    Permalink

    If this request router does not match a request then send the request to the specified default handler

    If this request router does not match a request then send the request to the specified default handler

    Definition Classes
    RequestRouter
  34. final def withDefaultHandler(handler: (Request, ExecutionContext) ⇒ Future[Response]): RequestRouter

    Permalink

    If this request router does not match a request then send the request to the specified default handler

    If this request router does not match a request then send the request to the specified default handler

    Definition Classes
    RequestRouter
  35. final def withDefaultHandler(handler: (Request) ⇒ Future[Response]): RequestRouter

    Permalink

    If this request router does not match a request then send the request to the specified default handler

    If this request router does not match a request then send the request to the specified default handler

    This is for backwards compatibility from when RequestHandler was a Function1[Request, Future[Response]]

    Definition Classes
    RequestRouter
  36. final def withErrorHandler(handler: ErrorRequestHandler): RequestRouter

    Permalink

    If a RequestHandler throws an Exception then run this handler.

    If a RequestHandler throws an Exception then run this handler. Useful for showing an Error Page when a request fails

    Definition Classes
    RequestRouter
  37. final def withErrorHandler(handler: (Request, Throwable, ExecutionContext) ⇒ Future[Response]): RequestRouter

    Permalink

    If a RequestHandler throws an Exception then run this handler.

    If a RequestHandler throws an Exception then run this handler. Useful for showing an Error Page when a request fails

    Definition Classes
    RequestRouter
  38. final def withErrorHandler(handler: (Request, Throwable) ⇒ Future[Response]): RequestRouter

    Permalink

    If a RequestHandler throws an Exception then run this handler.

    If a RequestHandler throws an Exception then run this handler. Useful for showing an Error Page when a request fails

    This is for backwards compatibility from when ErrorRequestHandler was a Function2[Requestm, Throwable, Future[Response]]

    Definition Classes
    RequestRouter
  39. def withFilter(filter: RequestFilter): RequestRouterAndHandler

    Permalink

    Run any RequestHandlers returned by this RequestRouter through a RequestFilter

    Run any RequestHandlers returned by this RequestRouter through a RequestFilter

    Definition Classes
    RequestRouterAndHandlerRequestHandlerRequestRouterWithFilter
  40. final def withFilter(filter: Option[RequestFilter]): RequestRouterAndHandler

    Permalink

    Run any RequestHandlers returned by this RequestRouter through an optional RequestFilter

    Run any RequestHandlers returned by this RequestRouter through an optional RequestFilter

    Definition Classes
    WithFilter
  41. final def withFilters(filters: TraversableOnce[RequestFilter]): RequestRouterAndHandler

    Permalink

    Run any RequestHandlers returned by this RequestRouter through a sequence of RequestFilter

    Run any RequestHandlers returned by this RequestRouter through a sequence of RequestFilter

    Definition Classes
    WithFilter

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Logging

Inherited from DefaultRequestRouter

Inherited from RequestRouterAndHandler

Inherited from RequestHandler

Inherited from RequestRouterBase

Inherited from RequestRouter

Inherited from AnyRef

Inherited from Any

Ungrouped