Router

Router defines mappings from HTTP requests to Routes.

Router can be nested

Router1 with Filter1
- Router2: endpoints e1, e2
- Router3: endpoints e3 with Filter2
Router4: endpoints e4

From this router definition, the backend HTTP server specific implementation will build a mapping table like this: e1 -> Filter1 andThen process(e1) e2 -> Filter1 andThen process(e2) e3 -> Filter1 andThen Filter2 andThen process(e3) e4 -> process(e4)

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Router(surface: Option[Surface] = None, children: Seq[Router] = Seq.empty, localRoutes: Seq[Route] = Seq.empty, filterSurface: Option[Surface] = None)

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
macro def add[Controller]: Router

Add methods annotated with @Endpoint to the routing table
def addChild(childRouter: Router): Router

Add a child and and return a new Router with this child node
def addInternal(controllerSurface: Surface, controllerMethodSurfaces: Seq[MethodSurface]): Router

Internal only method for adding the surface of the controller
macro def andThen[Controller]: Router
def andThen(next: Router): Router
final def asInstanceOf[T0]: T0

Definition Classes
Any
val children: Seq[Router]
def clone(): AnyRef

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

Definition Classes
AnyRef
val filterSurface: Option[Surface]
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def findRoute[Req](request: Req)(implicit arg0: HttpRequestAdapter[Req]): Option[RouteMatch]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def isEmpty: Boolean
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val localRoutes: Seq[Route]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def routes: Seq[Route]
val surface: Option[Surface]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Router → AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def withFilter(newFilterSurface: Surface): Router

Related Docs: object Router | package http

case class Router(surface: Option[Surface] = None, children: Seq[Router] = Seq.empty, localRoutes: Seq[Route] = Seq.empty, filterSurface: Option[Surface] = None) extends Product with Serializable

Instance Constructors

new Router(surface: Option[Surface] = None, children: Seq[Router] = Seq.empty, localRoutes: Seq[Route] = Seq.empty, filterSurface: Option[Surface] = None)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

macro def add[Controller]: Router

def addChild(childRouter: Router): Router

def addInternal(controllerSurface: Surface, controllerMethodSurfaces: Seq[MethodSurface]): Router

macro def andThen[Controller]: Router

def andThen(next: Router): Router

final def asInstanceOf[T0]: T0

val children: Seq[Router]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

val filterSurface: Option[Surface]

def finalize(): Unit

def findRoute[Req](request: Req)(implicit arg0: HttpRequestAdapter[Req]): Option[RouteMatch]

final def getClass(): Class[_]

def isEmpty: Boolean

final def isInstanceOf[T0]: Boolean

val localRoutes: Seq[Route]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def routes: Seq[Route]

val surface: Option[Surface]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withFilter(newFilterSurface: Surface): Router

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped