Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package twitter

    Start with com.twitter.finagle.

    Start with com.twitter.finagle.

    Definition Classes
    com
  • package finagle

    Finagle is an extensible RPC system.

    Finagle is an extensible RPC system.

    Services are represented by class com.twitter.finagle.Service. Clients make use of com.twitter.finagle.Service objects while servers implement them.

    Finagle contains a number of protocol implementations; each of these implement Client and/or com.twitter.finagle.Server. For example, Finagle's HTTP implementation, com.twitter.finagle.Http (in package finagle-http), exposes both.

    Thus a simple HTTP server is built like this:

    import com.twitter.finagle.{Http, Service}
import com.twitter.finagle.http.{Request, Response}
import com.twitter.util.{Await, Future}

val service = new Service[Request, Response] {
  def apply(req: Request): Future[Response] =
    Future.value(Response())
}
val server = Http.server.serve(":8080", service)
Await.ready(server)

    We first define a service to which requests are dispatched. In this case, the service returns immediately with a HTTP 200 OK response, and with no content.

    This service is then served via the Http protocol on TCP port 8080. Finally we wait for the server to stop serving.

    We can now query our web server:

    % curl -D - localhost:8080
HTTP/1.1 200 OK

    Building an HTTP client is also simple. (Note that type annotations are added for illustration.)

    import com.twitter.finagle.{Http, Service}
import com.twitter.finagle.http.{Request, Response}
import com.twitter.util.{Future, Return, Throw}

val client: Service[Request, Response] = Http.client.newService("localhost:8080")
val f: Future[Response] = client(Request()).respond {
  case Return(rep) =>
    printf("Got HTTP response %s\n", rep)
  case Throw(exc) =>
    printf("Got error %s\n", exc)
}

    Http.client.newService("localhost:8080") constructs a new com.twitter.finagle.Service instance connected to localhost TCP port 8080. We then issue a HTTP/1.1 GET request to URI "/". The service returns a com.twitter.util.Future representing the result of the operation. We listen to this future, printing an appropriate message when the response arrives.

    The Finagle homepage contains useful documentation and resources for using Finagle.

    Definition Classes
    twitter
  • package server
    Definition Classes
    finagle
  • Listener
  • ListeningStackServer
  • NullListener
  • ServerInfo
  • StackBasedServer
  • StackServer
  • StdStackServer
  • ThreadUsage

trait StackServer[Req, Rep] extends StackBasedServer[Req, Rep] with Parameterized[StackServer[Req, Rep]] with Transformable[StackServer[Req, Rep]]

A com.twitter.finagle.Server that composes a com.twitter.finagle.Stack.

See also

ListeningServer for a template implementation that tracks session resources.

Linear Supertypes
StackBasedServer[Req, Rep], Transformable[StackServer[Req, Rep]], Parameterized[StackServer[Req, Rep]], Server[Req, Rep], AnyRef, Any
Known Subclasses
Server, Server, Server, Server, PushStackServer, ListeningStackServer, StdStackServer
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StackServer
  2. StackBasedServer
  3. Transformable
  4. Parameterized
  5. Server
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def params: Params

    The current parameter map used in this StackServer.

    The current parameter map used in this StackServer.

    Definition Classes
    StackServer → Parameterized
  2. abstract def serve(addr: SocketAddress, service: ServiceFactory[Req, Rep]): ListeningServer

    Serve service at addr

    Serve service at addr

    Definition Classes
    Server
  3. abstract def stack: Stack[ServiceFactory[Req, Rep]]

    The current stack used in this StackServer.

  4. abstract def withParams(ps: Params): StackServer[Req, Rep]
    Definition Classes
    StackServer → Parameterized
  5. abstract def withStack(stack: Stack[ServiceFactory[Req, Rep]]): StackServer[Req, Rep]

    A new StackServer with the provided Stack.

    A new StackServer with the provided Stack.

    See also

    withStack that takes a Function1 for a more ergonomic API when used with method chaining.

Concrete 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def configured[P](psp: (P, Param[P])): StackServer[Req, Rep]

    Java friendly API for configured.

    Java friendly API for configured.

    The Tuple2 can often be created by calls to a mk(): (P, Stack.Param[P]) method on parameters (see com.twitter.finagle.loadbalancer.LoadBalancerFactory.Param.mk() as an example).

    Definition Classes
    Parameterized
  7. def configured[P](p: P)(implicit sp: Param[P]): StackServer[Req, Rep]

    Add the parameter, p, to the current Params.

    Add the parameter, p, to the current Params.

    Java users may find it easier to use the Tuple2 version below.

    Definition Classes
    Parameterized
  8. def configuredParams(newParams: Params): StackServer[Req, Rep]

    Adds all parameters, newParams, to the current Params.

    Adds all parameters, newParams, to the current Params.

    Definition Classes
    Parameterized
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def serve(addr: String, service: Service[Req, Rep]): ListeningServer

    Serve service at addr

    Serve service at addr

    Definition Classes
    Server
  19. final def serve(addr: String, service: ServiceFactory[Req, Rep]): ListeningServer

    Serve service at addr

    Serve service at addr

    Definition Classes
    Server
  20. final def serve(addr: SocketAddress, service: Service[Req, Rep]): ListeningServer

    Serve service at addr

    Serve service at addr

    Definition Classes
    Server
  21. def serveAndAnnounce(name: String, service: Service[Req, Rep]): ListeningServer

    Serve service at addr and announce with name.

    Serve service at addr and announce with name. Announcements will be removed when the service is closed. Omitting the addr will bind to an ephemeral port.

    Definition Classes
    Server
  22. def serveAndAnnounce(name: String, service: ServiceFactory[Req, Rep]): ListeningServer

    Serve service at addr and announce with name.

    Serve service at addr and announce with name. Announcements will be removed when the service is closed. Omitting the addr will bind to an ephemeral port.

    Definition Classes
    Server
  23. def serveAndAnnounce(name: String, addr: String, service: Service[Req, Rep]): ListeningServer

    Serve service at addr and announce with name.

    Serve service at addr and announce with name. Announcements will be removed when the service is closed. Omitting the addr will bind to an ephemeral port.

    Definition Classes
    Server
  24. def serveAndAnnounce(name: String, addr: String, service: ServiceFactory[Req, Rep]): ListeningServer

    Serve service at addr and announce with name.

    Serve service at addr and announce with name. Announcements will be removed when the service is closed. Omitting the addr will bind to an ephemeral port.

    Definition Classes
    Server
  25. def serveAndAnnounce(name: String, addr: SocketAddress, service: Service[Req, Rep]): ListeningServer

    Serve service at addr and announce with name.

    Serve service at addr and announce with name. Announcements will be removed when the service is closed. Omitting the addr will bind to an ephemeral port.

    Definition Classes
    Server
  26. def serveAndAnnounce(name: String, addr: SocketAddress, service: ServiceFactory[Req, Rep]): ListeningServer

    Serve service at addr and announce with name.

    Serve service at addr and announce with name. Announcements will be removed when the service is closed. Omitting the addr will bind to an ephemeral port.

    Definition Classes
    Server
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. def transformed(t: Stack.Transformer): StackServer[Req, Rep]

    Definition Classes
    StackServer → Transformable
    See also

    withStack

  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. def withStack(fn: (Stack[ServiceFactory[Req, Rep]]) => Stack[ServiceFactory[Req, Rep]]): StackServer[Req, Rep]

    A new StackServer using the function to create a new Stack.

    A new StackServer using the function to create a new Stack.

    The input to fn is the client's current stack. This API allows for easier usage when writing code that uses method chaining.

    This method is similar to transformed while providing easier API ergonomics for one-off Stack changes.

    Example:

    1. From Scala:

      import com.twitter.finagle.Http

Http.server.withStack(_.prepend(MyStackModule))

      From Java:

      import com.twitter.finagle.Http;
import static com.twitter.util.Function.func;

Http.server().withStack(func(stack -> stack.prepend(MyStackModule)));
    See also

    withStack(Stack)

    transformed

Inherited from StackBasedServer[Req, Rep]

Inherited from Transformable[StackServer[Req, Rep]]

Inherited from Parameterized[StackServer[Req, Rep]]

Inherited from Server[Req, Rep]

Inherited from AnyRef

Inherited from Any

Ungrouped