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
c

com.twitter.finagle.zipkin.thriftscala

Scribe$FinagleClient

class Scribe$FinagleClient extends Scribe[Future]

Annotations
@Generated()
Linear Supertypes
Scribe[Future], ThriftService, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Scribe$FinagleClient
  2. Scribe
  3. ThriftService
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Scribe$FinagleClient(service: Service[ThriftClientRequest, Array[Byte]], clientParam: RichClientParam)
  2. new Scribe$FinagleClient(service: Service[ThriftClientRequest, Array[Byte]], protocolFactory: TProtocolFactory, serviceName: String, stats: StatsReceiver)
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-08-16) Use com.twitter.finagle.thrift.RichClientParam

  3. new Scribe$FinagleClient(service: Service[ThriftClientRequest, Array[Byte]], protocolFactory: TProtocolFactory = Protocols.binaryFactory(), serviceName: String = "Scribe", stats: StatsReceiver = NullStatsReceiver, responseClassifier: ResponseClassifier = ctfs.ResponseClassifier.Default)
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-08-16) Use com.twitter.finagle.thrift.RichClientParam

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 LogScribeReplyDeserializer: (Array[Byte]) ⇒ Try[ResultCode]
  5. def asClosable: Closable

    Used to close the underlying Service.

    Used to close the underlying Service. Not a user-defined API.

    Definition Classes
    Scribe$FinagleClientScribe
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val clientParam: RichClientParam
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def decodeResponse[T <: ThriftStruct](resBytes: Array[Byte], codec: ThriftStructCodec[T]): T
    Attributes
    protected
  10. def encodeRequest(name: String, args: ThriftStruct): ThriftClientRequest
    Attributes
    protected
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def log(messages: Seq[LogEntry] = ...): Future[ResultCode]
    Definition Classes
    Scribe$FinagleClientScribe
  18. def missingResult(name: String): TApplicationException
    Attributes
    protected
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. val service: Service[ThriftClientRequest, Array[Byte]]
  23. def serviceName: String
  24. def setServiceName(ex: Throwable): Throwable
    Attributes
    protected
  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( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Scribe[Future]

Inherited from ThriftService

Inherited from AnyRef

Inherited from Any

Ungrouped