Endpoint

An Endpoint represents the HTTP endpoint.

I is well known and widely adopted in Finagle that "Your Server as a Function" (i.e., Request => Future[Response]. In a REST API setting this function may be viewed as Request =1=> (A =2=> Future[B]) =3=> Future[Response], where transformation 1 is request decoding (deserialization), transformation 2 - is business logic and transformation 3 is- response encoding (serialization). The only interesting part here is transformation 2 (i.e., A => Future[B]), which represents a bossiness logic of an application.

An Endpoint transformation (map, embedFlatMap, etc.) encodes the business logic, while the rest of Finch ecosystem takes care about both serialization and deserialization.

A typical way to transform (or map) the Endpoint is to use Mapper and Endpoint.apply method, which, depending on the argument type, delegates the map operation to the underlying function.

case class Foo(i: Int)
case class Bar(s: String)

val foo: Endpoint[Foo] = get("foo") { Ok(Foo(42)) }
val bar: Endpoint[Bar] = get("bar" / string) { s: String => Ok(Bar(s)) }

Endpoints are also composable in terms of or-else combinator (or a space invader :+:) that takes two Endpoints and gives a coproduct Endpoint.

val foobar: Endpoint[Foo :+: Bar :+: CNil] = foo :+: bar

An Endpoint might be converted into a Finagle Service with Endpoint.toService method so it can be served with Finagle HTTP.

Http.server.serve(foobar.toService)

Self Type: Endpoint[A]

Linear Supertypes

AnyRef, Any

Known Subclasses

*, /, Connect, Delete, Extractor, Get, Head, Options, Patch, Post, Put, TailExtractor, Trace, boolean, booleans, int, ints, long, longs, string, strings, uuid, uuids

Abstract Value Members

abstract def apply(input: Input): Option[(Input, () ⇒ Future[Output[A]])]

Extracts some value of type A from the given input.

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
def /[B](that: Endpoint[B])(implicit adjoin: PairAdjoin[A, B]): Endpoint[PairAdjoin.Out]

Composes this endpoint with the given that endpoint.
Composes this endpoint with the given that endpoint. The resulting endpoint will succeed only if both this and that endpoints succeed.
def :+:[B](that: Endpoint[B])(implicit adjoin: Adjoin[:+:[B, :+:[A, CNil]]]): Endpoint[shapeless.ops.adjoin.Adjoin.Out]

Composes this endpoint with another in such a way that coproducts are flattened.
final def ==(arg0: AnyRef): Boolean

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

Definition Classes
Any
def ?[B](that: RequestReader[B])(implicit adjoin: PairAdjoin[A, B]): Endpoint[PairAdjoin.Out]

Composes this endpoint with the given RequestReader.
def ap[B](fn: Endpoint[(A) ⇒ B]): Endpoint[B]

Maps this endpoint to Endpoint[A => B].
def apply(mapper: Mapper[A]): Endpoint[Out]

Maps this endpoint to either A => Output[B] or A => Output[Future[B]].
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def embedFlatMap[B](fn: (A) ⇒ Future[B]): Endpoint[B]

Maps this endpoint to the given function A => Future[B].
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 getClass(): Class[_]

Definition Classes
AnyRef → Any
def handle[B >: A](pf: PartialFunction[Throwable, Output[B]]): Endpoint[B]

Recovers from any exception occurred in this endpoint by creating a new endpoint that will handle any matching throwable from the underlying future.
def hashCode(): Int

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

Definition Classes
Any
def map[B](fn: (A) ⇒ B): Endpoint[B]

Maps this endpoint to the given function A => B.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def rescue[B >: A](pf: PartialFunction[Throwable, Future[Output[B]]]): Endpoint[B]

Recovers from any exception occurred in this endpoint by creating a new endpoint that will handle any matching throwable from the underlying future.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toService(implicit ts: ToService[A]): Service[Request, Response]

Converts this endpoint to a Finagle service Request => Future[Response].
def toString(): String

Definition Classes
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 withCharset(charset: Option[String]): Endpoint[A]
def withContentType(contentType: Option[String]): Endpoint[A]
def withCookie(cookie: Cookie): Endpoint[A]
def withFilter(p: (A) ⇒ Boolean): Endpoint[A]
def withHeader(header: (String, String)): Endpoint[A]
def |[B >: A](that: Endpoint[B]): Endpoint[B]

Sequentially composes this endpoint with the given that endpoint.
Sequentially composes this endpoint with the given that endpoint. The resulting router will succeed if either this or that endpoints are succeed.

trait Endpoint[A] extends AnyRef

Abstract Value Members

abstract def apply(input: Input): Option[(Input, () ⇒ Future[Output[A]])]

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def /[B](that: Endpoint[B])(implicit adjoin: PairAdjoin[A, B]): Endpoint[PairAdjoin.Out]

def :+:[B](that: Endpoint[B])(implicit adjoin: Adjoin[:+:[B, :+:[A, CNil]]]): Endpoint[shapeless.ops.adjoin.Adjoin.Out]

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def ?[B](that: RequestReader[B])(implicit adjoin: PairAdjoin[A, B]): Endpoint[PairAdjoin.Out]

def ap[B](fn: Endpoint[(A) ⇒ B]): Endpoint[B]

def apply(mapper: Mapper[A]): Endpoint[Out]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def embedFlatMap[B](fn: (A) ⇒ Future[B]): Endpoint[B]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def handle[B >: A](pf: PartialFunction[Throwable, Output[B]]): Endpoint[B]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def map[B](fn: (A) ⇒ B): Endpoint[B]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def rescue[B >: A](pf: PartialFunction[Throwable, Future[Output[B]]]): Endpoint[B]

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

def toService(implicit ts: ToService[A]): Service[Request, Response]

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withCharset(charset: Option[String]): Endpoint[A]

def withContentType(contentType: Option[String]): Endpoint[A]

def withCookie(cookie: Cookie): Endpoint[A]

def withFilter(p: (A) ⇒ Boolean): Endpoint[A]

def withHeader(header: (String, String)): Endpoint[A]

def |[B >: A](that: Endpoint[B]): Endpoint[B]

Inherited from AnyRef

Inherited from Any

Ungrouped