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 thrift

    Please use the new interface, com.twitter.finagle.Thrift, for constructing Thrift clients and servers.

    Deprecation

    Please use the new interface, com.twitter.finagle.Thrift, for constructing Thrift clients and servers.

    Thrift codecs

    We provide client and server protocol support for the framed protocol. The public implementations are defined on the Thrift object:

    The type of the server codec is Service[Array[Byte], Array[Byte]] and the client codecs are Service[ThriftClientRequest, Array[Byte]]. The service provided is that of a "transport" of thrift messages (requests and replies) according to the protocol chosen. This is why the client codecs need to have access to a thrift ProtocolFactory.

    These transports are used by the services produced by the finagle thrift codegenerator.

    val service: Service[ThriftClientRequest, Array[Byte]] = ClientBuilder()
  .hosts("foobar.com:123")
  .stack(Thrift.client)
  .build()

// Wrap the raw Thrift transport in a Client decorator. The client
// provides a convenient procedural interface for accessing the Thrift
// server.
val client = new Hello.ServiceToClient(service, protocolFactory)

    In this example, Hello is the thrift interface, and the inner class ServiceToClient is provided by the finagle thrift code generator.

    Definition Classes
    finagle
  • package exp
    Definition Classes
    thrift
  • package partitioning
    Definition Classes
    exp
  • ClientCustomStrategies
  • ClientCustomStrategy
  • ClientHashingStrategy
  • CustomPartitioningStrategy
  • HashingPartitioningStrategy
  • MethodBuilderCustomStrategy
  • MethodBuilderHashingStrategy
  • PartitioningParams
  • PartitioningStrategy
  • WithThriftPartitioningStrategy

object ClientCustomStrategy

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClientCustomStrategy
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type ToPartitionedMap = PartialFunction[ThriftStructIface, Future[Map[Int, ThriftStructIface]]]

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 clusterResharding(getPartitionIdAndRequestFn: (Set[Address]) => ToPartitionedMap, getLogicalPartitionIdFn: (Set[Address]) => (Int) => Seq[Int]): CustomPartitioningStrategy

    Constructs a ClientCustomStrategy that reshards based on the remote cluster state.

    Constructs a ClientCustomStrategy that reshards based on the remote cluster state.

    This is appropriate for simple custom strategies where you only need to know information about the remote cluster in order to reshard. For example, if you want to be able to add or remove capacity safely.

    Java users should see ClientCustomStrategies$ for an easier to use API.

    getPartitionIdAndRequestFn

    A function that given the current state of the remote cluster, returns a PartialFunction implemented by client that provides the partitioning logic on a request. It takes a Thrift object request, and returns Future Map of partition ids to sub-requests. If we don't need to fan-out, it should return one element: partition id to the original request. This PartialFunction can take multiple Thrift request types of one Thrift service (different method endpoints of one service). Note that this function must be pure (ie referentially transparent). It cannot change based on anything other than the state of the remote cluster it is provided with, or else it will malfunction.

    getLogicalPartitionIdFn

    A function that given the current state of the remote cluster, returns a function that gets the logical partition identifiers from a host identifier, host identifiers are derived from ZkMetadata shardId. Indicates which logical partitions a physical host belongs to, multiple hosts can belong to the same partition, and one host can belong to multiple partitions, for example:

    {
  case a if Range(0, 10).contains(a) => Seq(0, 1)
  case b if Range(10, 20).contains(b) => Seq(1)
  case c if Range(20, 30).contains(c) => Seq(2)
  case _ => throw ...
}

    Note that this function must be pure (ie referentially transparent). It cannot change based on anything other than the state of the remote cluster it is provided with, or else it will malfunction.

  7. def clusterResharding(getPartitionIdAndRequestFn: (Set[Address]) => ToPartitionedMap): CustomPartitioningStrategy

    Constructs a ClientCustomStrategy that reshards based on the remote cluster state.

    Constructs a ClientCustomStrategy that reshards based on the remote cluster state.

    This is appropriate for simple custom strategies where you only need to know information about the remote cluster in order to reshard. For example, if you want to be able to add or remove capacity safely.

    Java users should see ClientCustomStrategies$ for an easier to use API.

    getPartitionIdAndRequestFn

    A function that given the current state of the remote cluster, returns a function that gets the logical partition identifier from a host identifier, host identifiers are derived from ZkMetadata shardId. Indicates which logical partition a physical host belongs to, multiple hosts can belong to the same partition, and one host can belong to multiple partitions, for example:

    {
  case a if Range(0, 10).contains(a) => Seq(0, 1)
  case b if Range(10, 20).contains(b) => Seq(1)
  case c if Range(20, 30).contains(c) => Seq(2)
  case _ => throw ...
}

    Note that this function must be pure (ie referentially transparent). It cannot change based on anything other than the state of the remote cluster it is provided with, or else it will malfunction.

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def noResharding(getPartitionIdAndRequest: ToPartitionedMap, getLogicalPartitionId: (Int) => Seq[Int]): CustomPartitioningStrategy

    Constructs a ClientCustomStrategy that does not reshard.

    Constructs a ClientCustomStrategy that does not reshard.

    This is appropriate for static partitioning backend topologies.

    Java users should see ClientCustomStrategies$ for an easier to use API.

    getPartitionIdAndRequest

    A PartialFunction implemented by client that provides the partitioning logic on a request. It takes a Thrift object request, and returns Future Map of partition ids to sub-requests. If we don't need to fan-out, it should return one element: partition id to the original request. This PartialFunction can take multiple Thrift request types of one Thrift service (different method endpoints of one service).

    getLogicalPartitionId

    Gets the logical partition identifiers from a host identifier, host identifiers are derived from ZkMetadata shardId. Indicates which logical partitions a physical host belongs to, multiple hosts can belong to the same partition, and one host can belong to multiple partitions, for example:

    {
  case a if Range(0, 10).contains(a) => Seq(0, 1)
  case b if Range(10, 20).contains(b) => Seq(1)
  case c if Range(20, 30).contains(c) => Seq(2)
  case _ => throw ...
}
  16. def noResharding(getPartitionIdAndRequest: ToPartitionedMap): CustomPartitioningStrategy

    Constructs a ClientCustomStrategy that does not reshard.

    Constructs a ClientCustomStrategy that does not reshard.

    This is appropriate for static partitioning backend topologies.

    Java users should see ClientCustomStrategies$ for an easier to use API.

    getPartitionIdAndRequest

    A PartialFunction implemented by client that provides the partitioning logic on a request. It takes a Thrift object request, and returns Future Map of partition ids to sub-requests. If we don't need to fan-out, it should return one element: partition id to the original request. This PartialFunction can take multiple Thrift request types of one Thrift service (different method endpoints of one service). In this context, the returned partition id is also the shard id. Each instance is its own partition.

  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. def resharding[A](getPartitionIdAndRequestFn: (A) => ToPartitionedMap, getLogicalPartitionIdFn: (A) => (Int) => Seq[Int], observable: Activity[A]): CustomPartitioningStrategy

    Constructs a ClientCustomStrategy that reshards based on the user provided state.

    Constructs a ClientCustomStrategy that reshards based on the user provided state.

    This lets the client be aware of the backend dynamic resharding by providing the fully described state of resharding. The partitioning schema needs to be configured to react to each state, and it needs to be a pure function (see param below). When the state got successfully updated, the partitioning strategy will move to the new schema. See clusterResharding if only the backend cluster information needs to be observed in order to reshard.

    Java users should see ClientCustomStrategies$ for an easier to use API.

    getPartitionIdAndRequestFn

    A function that given the current state of observable, returns a PartialFunction implemented by client that provides the partitioning logic on a request. It takes a Thrift object request, and returns Future Map of partition ids to sub-requests. If we don't need to fan-out, it should return one element: partition id to the original request. This PartialFunction can take multiple Thrift request types of one Thrift service (different method endpoints of one service). Note that this function must be pure (ie referentially transparent). It cannot change based on anything other than the state of observable, or else it will malfunction.

    getLogicalPartitionIdFn

    A function that given the current state observable, returns a function that gets the logical partition identifiers from a host identifier, host identifiers are derived from ZkMetadata shardId. Indicates which logical partitions a physical host belongs to, multiple hosts can belong to the same partition, and one host can belong to multiple partitions, for example:

    {
  case a if Range(0, 10).contains(a) => Seq(0, 1)
  case b if Range(10, 20).contains(b) => Seq(1)
  case c if Range(20, 30).contains(c) => Seq(2)
  case _ => throw ...
}

    Note that this function must be pure (ie referentially transparent). It cannot change based on anything other than the state of observable, or else it will malfunction.

    observable

    The state that is used for deciding how to reshard the cluster.

  20. def resharding[A](getPartitionIdAndRequestFn: (A) => ToPartitionedMap, observable: Activity[A]): CustomPartitioningStrategy

    Constructs a ClientCustomStrategy that reshards based on the user provided state.

    Constructs a ClientCustomStrategy that reshards based on the user provided state.

    This lets the client be aware of the backend dynamic resharding by providing the fully described state of resharding. The partitioning schema needs to be configured to react to each state, and it needs to be a pure function (see param below). When the state got successfully updated, the partitioning strategy will move to the new schema. See clusterResharding if only the backend cluster information needs to be observed in order to reshard.

    Java users should see ClientCustomStrategies$ for an easier to use API.

    getPartitionIdAndRequestFn

    A function that given the current state of observable, returns a PartialFunction implemented by client that provides the partitioning logic on a request. It takes a Thrift object request, and returns Future Map of partition ids to sub-requests. If we don't need to fan-out, it should return one element: partition id to the original request. This PartialFunction can take multiple Thrift request types of one Thrift service (different method endpoints of one service). Note that this function must be pure (ie referentially transparent). It cannot change based on anything other than the state of observable, or else it will malfunction.

    observable

    The state that is used for deciding how to reshard the cluster.

  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  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 AnyRef

Inherited from Any

Ungrouped