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 zookeeper
    Definition Classes
    finagle
  • ZkAnnouncer
  • ZkAnnouncerException
  • ZkResolver
  • ZkResolverException

class ZkAnnouncer extends Announcer

When announcing an endpoint with additional endpoints they all need to join the path together. However, announcements are decoupled and can happen in any order. The ZkAnnouncer will gather endpoints together in order to announce them as a group. Main endpoints are required and are thus announced immediately while additional endpoints are only announced if the path also has a main endpoint. For this reason if a main endpoint is announced first and an additional endpoint announced later, the announcer must leave the path and re-announce. The process is similar: leave the path, then remove either the additional endpoint or the main endpoint, re-join only if the main endpoint exists. Also it is also

Self Type
ZkAnnouncer
Note

Requiring the shardId in some of the announce methods is an unfortunate artifact of the implementation of ServerSets. For most uses setting it to 0 is sufficient.

,

announcing multiple endpoints can happen in two different ways. One by calling announce separately for each endpoint as mentioned above, and another by calling announce and passing additionalEndpoints to it directly in the same method call.

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

Instance Constructors

  1. new ZkAnnouncer()
  2. new ZkAnnouncer(factory: ZkClientFactory)

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. def announce(ia: InetSocketAddress, addr: String, metadata: Map[String, String], additionalEndpoints: Map[String, InetSocketAddress]): Future[Announcement]

    additionalEndpoints

    if this is non-empty these endpoints are announced along with the primary addr

  5. def announce(ia: InetSocketAddress, addr: String, metadata: Map[String, String]): Future[Announcement]
  6. def announce(ia: InetSocketAddress, addr: String): Future[Announcement]
    Definition Classes
    ZkAnnouncerAnnouncer
  7. def announce(client: ZooKeeperClient, path: String, shardId: Int, addr: InetSocketAddress, endpoint: Option[String], metadata: Map[String, String], additionalEndpoints: Map[String, InetSocketAddress]): Future[Announcement]

    additionalEndpoints

    if this is non-empty these endpoints are announced along with the primary addr

  8. def announce(client: ZooKeeperClient, path: String, shardId: Int, addr: InetSocketAddress, endpoint: Option[String], metadata: Map[String, String]): Future[Announcement]
  9. def announce(client: ZooKeeperClient, path: String, shardId: Int, addr: InetSocketAddress, endpoint: Option[String]): Future[Announcement]
  10. def announce(hosts: String, path: String, shardId: Int, addr: InetSocketAddress, endpoint: Option[String], metadata: Map[String, String], additionalEndpoints: Map[String, InetSocketAddress]): Future[Announcement]

    additionalEndpoints

    if this is non-empty these endpoints are announced along with the primary addr

  11. def announce(hosts: String, path: String, shardId: Int, addr: InetSocketAddress, endpoint: Option[String], metadata: Map[String, String]): Future[Announcement]
  12. def announce(hosts: String, path: String, shardId: Int, addr: InetSocketAddress, endpoint: Option[String]): Future[Announcement]
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. val scheme: String
    Definition Classes
    ZkAnnouncerAnnouncer
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Announcer

Inherited from AnyRef

Inherited from Any

Ungrouped