Packages

class HttpMuxer extends Service[Request, Response]

A service that dispatches incoming requests to registered handlers. In order to choose which handler to dispatch the request to, we take the path of the request and match it with the patterns of the pre-registered handlers. The pattern matching follows these rules:

  • Patterns ending with "/" use exclusive prefix matching. Eg: the pattern "foo/bar/" matches these paths: "foo/bar/", "foo/bar/baz", etc but NOT "foo/bar" Similarly, the pattern "/" matches all paths
  • Patterns not ending with "/" use exact matching. Eg: the pattern "foo/bar" ONLY matches this path: "foo/bar"
  • Special case: The pattern "" matches only "/" and ""

NOTE: When multiple pattern matches exist, the longest pattern wins.

Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpMuxer
  2. Service
  3. Closable
  4. Function1
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new HttpMuxer()
  2. new HttpMuxer(_routes: Seq[Route])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def andThen[A](g: (Future[Response]) => A): (Request) => A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  5. def apply(request: Request): Future[Response]

    Extract path from Request; look for a matching pattern; if found, dispatch the Request to the registered service; otherwise create a NOT_FOUND response

    Extract path from Request; look for a matching pattern; if found, dispatch the Request to the registered service; otherwise create a NOT_FOUND response

    Definition Classes
    HttpMuxerService → Function1
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def close(deadline: Time): Future[Unit]
    Definition Classes
    HttpMuxerService → Closable
  9. def close(after: Duration): Future[Unit]
    Definition Classes
    Closable
  10. final def close(): Future[Unit]
    Definition Classes
    Closable
  11. def compose[A](g: (A) => Request): (A) => Future[Response]
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isAvailable: Boolean

    Determines whether this Service is available (can accept requests with a reasonable likelihood of success).

    Determines whether this Service is available (can accept requests with a reasonable likelihood of success).

    Definition Classes
    Service
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def map[Req1](f: (Req1) => Request): Service[Req1, Response]
    Definition Classes
    Service
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def patterns: Seq[String]
  24. def route(request: Request): Option[Route]

    Find the route that a request will take, or None if there's no matching route.

  25. def routes: Seq[Route]
    Attributes
    protected
  26. def status: finagle.Status

    The current availability Status of this Service.

    The current availability Status of this Service.

    Definition Classes
    Service
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    Service → Function1 → AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. def withHandler(route: Route): HttpMuxer
  33. def withHandler(pattern: String, service: Service[Request, Response]): HttpMuxer

    Create a new Mux service with the specified pattern added.

    Create a new Mux service with the specified pattern added. If the pattern already exists, overwrite existing value. Pattern ending with "/" indicates prefix matching; otherwise exact matching.

Inherited from Service[Request, Response]

Inherited from Closable

Inherited from (Request) => Future[Response]

Inherited from AnyRef

Inherited from Any

Ungrouped