AbstractRouter

Instance Constructors

new AbstractRouter(label: String, jRoutes: Iterable[Route])

label
A label used for identifying this Router (i.e. for distinguishing between Router instances in error messages or for StatsReceiver scope).
jRoutes
All of the Route routes contained within this Router, represented as a Java JIterable.

Abstract Value Members

abstract def findAny(input: Input): Optional[Route]

Java-friendly version of find
Java-friendly version of find

Attributes
protected

Concrete 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
def andThen[A](g: (Option[Route]) ⇒ A): (Input) ⇒ A

Definition Classes
Function1
Annotations
@unspecialized()
final def apply(input: Input): Option[Route]

Attempt to route an Input to a Route route known by this Router.
Attempt to route an Input to a Route route known by this Router.
input
The Input to use for determining an available route
returns
Some(Route) if a route is found to match, None otherwise

Definition Classes
Router → Function1
Note
A ClosedRouterException will be thrown if close has been initiated on this router and subsequent routing attempts are received.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def close(deadline: Time): Future[Unit]

Definition Classes
CloseOnce
def close(after: Duration): Future[Unit]

Definition Classes
Closable
final def close(): Future[Unit]

Definition Classes
Closable
def closeOnce(deadline: Time): Future[Unit]

<invalid inheritdoc annotation>
<invalid inheritdoc annotation>

Attributes
protected
Definition Classes
Router → CloseOnce
Note
NonFatal exceptions encountered when calling close() on a Route will be suppressed and Fatal exceptions will take on the same exception behavior of a Future.join.
def compose[A](g: (A) ⇒ Input): (A) ⇒ Option[Route]

Definition Classes
Function1
Annotations
@unspecialized()
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def find(input: Input): Option[Route]

Logic used to determine if this Router contains a Route for an Input.
Logic used to determine if this Router contains a Route for an Input.
input
The Input to determine a route for.
returns
Some(Route) if a matching route is defined, None if a route destination is not defined for the Input.

Attributes
protected
Definition Classes
AbstractRouter → Router
Note
This method is only meant to be called within the Router's apply, which handles lifecycle concerns. It should not be accessed directly.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getLogger(): Logger

The Logger to use for this Router.
The Logger to use for this Router. Can be overridden to customize.
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isClosed: Boolean

Definition Classes
CloseOnce
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val label: String

A label used for identifying this Router (i.e.
A label used for identifying this Router (i.e. for distinguishing between Router instances in error messages or for StatsReceiver scope).

Definition Classes
AbstractRouter → Router
final def logger: Logger

The Logger to use for this Router.
The Logger to use for this Router. Can be overridden to customize.

Definition Classes
AbstractRouter → Router
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def route(input: Input): Optional[Route]

Java-friendly version of apply
final val routes: Iterable[Route]

All of the Route routes contained within this Router
All of the Route routes contained within this Router

Definition Classes
AbstractRouter → Router
Note
This property is used to linearly determine the routes when closed() is called. It may also be used as a way to determine what routes are defined within a Router (i.e. for generating meaningful error messages). This property does not imply any relationship with apply or find or that a Router's runtime behavior needs to be linear.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Function1 → 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( ... )

Related Doc: package routing

abstract class AbstractRouter[Input, Route] extends Router[Input, Route]

Instance Constructors

new AbstractRouter(label: String, jRoutes: Iterable[Route])

Abstract Value Members

abstract def findAny(input: Input): Optional[Route]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def andThen[A](g: (Option[Route]) ⇒ A): (Input) ⇒ A

final def apply(input: Input): Option[Route]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def close(deadline: Time): Future[Unit]

def close(after: Duration): Future[Unit]

final def close(): Future[Unit]

def closeOnce(deadline: Time): Future[Unit]

def compose[A](g: (A) ⇒ Input): (A) ⇒ Option[Route]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def find(input: Input): Option[Route]

final def getClass(): Class[_]

def getLogger(): Logger

def hashCode(): Int

final def isClosed: Boolean

final def isInstanceOf[T0]: Boolean

val label: String

final def logger: Logger

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def route(input: Input): Optional[Route]

final val routes: Iterable[Route]

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

Inherited from Router[Input, Route]

Inherited from ClosableOnce

Inherited from CloseOnce

Inherited from Closable

Inherited from (Input) ⇒ Option[Route]

Inherited from AnyRef

Inherited from Any

Ungrouped