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

case class Endpoint(names: Array[String], host: String, port: Int, shard: Int, status: Endpoint.Status.Value, memberId: String, metadata: Map[String, String]) extends Entry with Product with Serializable

Endpoints encode a destination announced via serversets.

names

The endpoint name. Null describes a default service endpoint.

host

The host of the endpoint (or null if unset).

port

The port of the endpoint (or Int.MinValue if unset).

shard

The shard id of the endpoint (or Int.MinValue if unset).

status

The endpoint's status.

memberId

The endpoint's member id, used as a foreign key for endpoints.

metadata

The metadata associated with the endpoint.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Endpoint
  2. Serializable
  3. Product
  4. Equals
  5. Entry
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Endpoint(names: Array[String], host: String, port: Int, shard: Int, status: Endpoint.Status.Value, memberId: String, metadata: Map[String, String])

    names

    The endpoint name. Null describes a default service endpoint.

    host

    The host of the endpoint (or null if unset).

    port

    The port of the endpoint (or Int.MinValue if unset).

    shard

    The shard id of the endpoint (or Int.MinValue if unset).

    status

    The endpoint's status.

    memberId

    The endpoint's member id, used as a foreign key for endpoints.

    metadata

    The metadata associated with the endpoint.

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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(that: Any): Boolean
    Definition Classes
    Endpoint → Equals → AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. val host: String
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val memberId: String
  13. val metadata: Map[String, String]
  14. val names: Array[String]
  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. val port: Int
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. val shard: Int
  21. val status: Endpoint.Status.Value
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Entry

Inherited from AnyRef

Inherited from Any

Ungrouped