Packages

  • package root
    Definition Classes
    root
  • package com

    Start with com.twitter.finagle.

    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 client
    Definition Classes
    finagle
  • AddrMetadataExtraction
  • DefaultPool
  • DynamicTimeout
  • EndpointerModule
  • EndpointerStackClient
  • LatencyCompensation
  • StackBasedClient
  • StackClient
  • StatsScoping
  • StdStackClient
  • Transporter

case class DefaultPool[Req, Rep](low: Int = 0, high: Int = Int.MaxValue, bufferSize: Int = 0, idleTime: Duration = Duration.Top, maxWaiters: Int = Int.MaxValue, timer: Timer = DefaultTimer) extends (StatsReceiver) ⇒ Transformer[Req, Rep] with Product with Serializable

Create a watermark pool backed by a caching pool. This is the default pooling setup of Finagle.

low

The low watermark used in the Watermark pool. If there is sufficient request concurrency, no fewer connections will be maintained by the pool.

high

The high watermark. The pool will not maintain more connections than this.

bufferSize

Specifies the size of the lock-free buffer in front of the pool configuration. Skipped if 0.

idleTime

The amount of idle time for which a connection is cached. This is applied to connections that number greater than the low watermark but fewer than the high.

maxWaiters

The maximum number of connection requests that are queued when the connection concurrency exceeds the high watermark.

Linear Supertypes
Serializable, Serializable, Product, Equals, (StatsReceiver) ⇒ Transformer[Req, Rep], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultPool
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Function1
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DefaultPool(low: Int = 0, high: Int = Int.MaxValue, bufferSize: Int = 0, idleTime: Duration = Duration.Top, maxWaiters: Int = Int.MaxValue, timer: Timer = DefaultTimer)

    low

    The low watermark used in the Watermark pool. If there is sufficient request concurrency, no fewer connections will be maintained by the pool.

    high

    The high watermark. The pool will not maintain more connections than this.

    bufferSize

    Specifies the size of the lock-free buffer in front of the pool configuration. Skipped if 0.

    idleTime

    The amount of idle time for which a connection is cached. This is applied to connections that number greater than the low watermark but fewer than the high.

    maxWaiters

    The maximum number of connection requests that are queued when the connection concurrency exceeds the high watermark.

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 andThen[A](g: (Transformer[Req, Rep]) ⇒ A): (StatsReceiver) ⇒ A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  5. def apply(statsReceiver: StatsReceiver): (ServiceFactory[Req, Rep]) ⇒ ServiceFactory[Req, Rep]
    Definition Classes
    DefaultPool → Function1
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val bufferSize: Int
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def compose[A](g: (A) ⇒ StatsReceiver): (A) ⇒ Transformer[Req, Rep]
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  13. val high: Int
  14. val idleTime: Duration
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val low: Int
  17. val maxWaiters: Int
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. val timer: Timer
  23. def toString(): String
    Definition Classes
    Function1 → AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from (StatsReceiver) ⇒ Transformer[Req, Rep]

Inherited from AnyRef

Inherited from Any

Ungrouped