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 zipkin
    Definition Classes
    finagle
  • package thriftscala
    Definition Classes
    zipkin
  • LogEntry
  • ResultCode
  • Scribe
  • Scribe$FinagleClient
  • Scribe$FinagleService

object Scribe extends GeneratedThriftService

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Scribe
  2. GeneratedThriftService
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class Filter extends AnyRef
  2. class FinagledClient extends Scribe$FinagleClient with FutureIface with MethodPerEndpoint
  3. class FinagledService extends Scribe$FinagleService
  4. trait MethodPerEndpoint extends Scribe[Future]
  5. trait ReqRepServicePerEndpoint extends ToThriftService with Filterable[ReqRepServicePerEndpoint]
  6. trait ServicePerEndpoint extends ToThriftService with Filterable[ServicePerEndpoint]
  7. type log$args = Args
  8. type log$result = Result
  9. trait BaseServiceIface extends ToThriftService
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-11-07) Use ServicePerEndpoint

  10. trait FutureIface extends Scribe[Future]
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-11-07) Use MethodPerEndpoint

  11. class MethodIface extends FutureIface
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-11-07) Use MethodPerEndpoint

  12. case class ServiceIface(log: Service[Args, SuccessType]) extends BaseServiceIface with Filterable[ServiceIface] with Product with Serializable
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-11-07) Use ServicePerEndpoint

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. val annotations: Map[String, String]

    Thrift annotations (user-defined key-value metadata) on the service

    Thrift annotations (user-defined key-value metadata) on the service

    Definition Classes
    ScribeGeneratedThriftService
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    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. val log$args: Args.type
  14. val log$result: Result.type
  15. val methods: Set[ThriftMethod]

    The set of ThriftMethods that this service is responsible for handling

    The set of ThriftMethods that this service is responsible for handling

    Definition Classes
    ScribeGeneratedThriftService
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. def unsafeBuildFromMethods(methods: Map[ThriftMethod, Service[Request[_], Response[_]]]): ReqRepServicePerEndpoint

    Generate a ReqRepServicePerEndpoint from a map of ThriftMethod -> Service[Request[Args], Response[SuccessType]] implementations.

    Generate a ReqRepServicePerEndpoint from a map of ThriftMethod -> Service[Request[Args], Response[SuccessType]] implementations. This is unsafe because it does not check that the implementation associated with a ThriftMethod is typed properly until this service attempts to serve a request.

    Definition Classes
    ScribeGeneratedThriftService
    Exceptions thrown

    IllegalArgumentException if an implementation is missing

  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  25. object Log extends ThriftMethod
  26. object MethodPerEndpoint
  27. implicit object MethodPerEndpointBuilder extends MethodPerEndpointBuilder[ServicePerEndpoint, MethodPerEndpoint]
  28. object ReqRepMethodPerEndpoint
  29. implicit object ReqRepMethodPerEndpointBuilder extends ReqRepMethodPerEndpointBuilder[ReqRepServicePerEndpoint, MethodPerEndpoint]
  30. object ReqRepServicePerEndpoint
  31. implicit object ReqRepServicePerEndpointBuilder extends ReqRepServicePerEndpointBuilder[ReqRepServicePerEndpoint]
  32. object ServicePerEndpoint
  33. implicit object ServicePerEndpointBuilder extends ServicePerEndpointBuilder[ServicePerEndpoint]

Deprecated Value Members

  1. implicit object MethodIfaceBuilder extends MethodIfaceBuilder[ServiceIface, Scribe[Future]]
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-11-07) Use MethodPerEndpointBuilder

  2. implicit object ReqRepThriftServiceBuilder extends ReqRepThriftServiceBuilder[ReqRepServicePerEndpoint, Scribe[Future]]
    Annotations
    @deprecated
    Deprecated

    (Since version 2018-01-12) Use ReqRepMethodPerEndpointBuilder

  3. implicit object ServiceIfaceBuilder extends ServiceIfaceBuilder[ServiceIface]
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-11-07) Use ServicePerEndpointBuilder

  4. implicit object ThriftServiceBuilder extends ThriftServiceBuilder[ServicePerEndpoint, Scribe[Future]]
    Annotations
    @deprecated
    Deprecated

    (Since version 2018-01-12) Use MethodPerEndpointBuilder

Inherited from GeneratedThriftService

Inherited from AnyRef

Inherited from Any

Ungrouped