Packages

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

    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 serverset2
    Definition Classes
    finagle
  • package client
    Definition Classes
    serverset2
  • package naming
    Definition Classes
    serverset2
  • Endpoint
  • Entry
  • Identity
  • RetryStream
  • UserIdentity
  • Zk2Resolver
  • chatty
  • dnsCacheSize
  • zkConcurrentOperations

class Zk2Resolver extends Resolver

A com.twitter.finagle.Resolver for the "zk2" service discovery scheme.

Resolution is achieved by looking up registered ServerSet paths within a service discovery ZooKeeper cluster. See Zk2Resolver.bind for details.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Zk2Resolver
  2. Resolver
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Zk2Resolver()
  2. new Zk2Resolver(statsReceiver: StatsReceiver)
  3. new Zk2Resolver(statsReceiver: StatsReceiver, stabilizerWindow: Duration, unhealthyWindow: Duration)
  4. new Zk2Resolver(statsReceiver: StatsReceiver, stabilizerWindow: Duration, unhealthyWindow: Duration, timer: Timer)
  5. new Zk2Resolver(statsReceiver: StatsReceiver, stabilizerWindow: Duration, unhealthyWindow: Duration, inetResolver: InetResolver, timer: Timer)

    statsReceiver

    maintains stats and gauges used in resolution

    stabilizerWindow

    the window over which we stabilize updates from zk as per the semantics of the Stabilizer.

    unhealthyWindow

    how long must the zk client be unhealthy before reporting trouble

    inetResolver

    used to perform address resolution

    timer

    timer to use for stabilization and zk sessions

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 bind(arg: String): Var[Addr]

    Bind a string into a variable address using the zk2 scheme.

    Bind a string into a variable address using the zk2 scheme.

    NOTE: This specific API doesn't take "zk2!" as a protocol prefix, but when used with just Resolver, "zk2!" is expected as a prefix. Clients should be using the Resolver API rather than this direct interface.

    Argument strings must adhere to either of the following formats:

    <hosts>:2181!<path> <hosts>:2181!<path>!<endpoint>

    where

    - <hosts>: The hostname(s) of service discovery ZooKeeper cluster - <path>: A ServerSet path (e.g. /twitter/service/userservice/prod/server) - <endpoint>: An endpoint name (optional)

    Definition Classes
    Zk2ResolverResolver
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. val scheme: String
    Definition Classes
    Zk2ResolverResolver
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Resolver

Inherited from AnyRef

Inherited from Any

Ungrouped