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 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 scribe
    Definition Classes
    thrift
  • package thriftscala
    Definition Classes
    scribe
  • LogEntry
  • ResultCode
  • Scribe
  • Scribe$FinagleClient
  • Scribe$FinagleService
c

com.twitter.finagle.thrift.scribe.thriftscala

Scribe$FinagleService

class Scribe$FinagleService extends Service[Array[Byte], Array[Byte]]

Annotations
@Generated()
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Scribe$FinagleService
  2. Service
  3. Closable
  4. Function1
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Scribe$FinagleService(iface: Scribe[Future], serverParam: RichServerParam)
  2. new Scribe$FinagleService(iface: Scribe[Future], protocolFactory: TProtocolFactory)
    Annotations
    @deprecated
    Deprecated

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

  3. new Scribe$FinagleService(iface: Scribe[Future], protocolFactory: TProtocolFactory, stats: StatsReceiver, maxThriftBufferSize: Int)
    Annotations
    @deprecated
    Deprecated

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

  4. new Scribe$FinagleService(iface: Scribe[Future], protocolFactory: TProtocolFactory, stats: StatsReceiver = NullStatsReceiver, maxThriftBufferSize: Int = Thrift.param.maxThriftBufferSize, serviceName: String = "Scribe")
    Annotations
    @deprecated
    Deprecated

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

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 addService(name: String, service: Service[(TProtocol, Int), Array[Byte]]): Unit
    Attributes
    protected
  5. def andThen[A](g: (Future[Array[Byte]]) ⇒ A): (Array[Byte]) ⇒ A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  6. final def apply(request: Array[Byte]): Future[Array[Byte]]

    This is the method to override/implement to create your own Service.

    This is the method to override/implement to create your own Service.

    Definition Classes
    Scribe$FinagleServiceService → Function1
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. def close(deadline: Time): Future[Unit]
    Definition Classes
    Service → Closable
  10. def close(after: Duration): Future[Unit]
    Definition Classes
    Closable
  11. final def close(): Future[Unit]
    Definition Classes
    Closable
  12. def compose[A](g: (A) ⇒ Array[Byte]): (A) ⇒ Future[Array[Byte]]
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isAvailable: Boolean

    Determines whether this Service is available (can accept requests with a reasonable likelihood of success).

    Determines whether this Service is available (can accept requests with a reasonable likelihood of success).

    Definition Classes
    Service
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def map[Req1](f: (Req1) ⇒ Array[Byte]): Service[Req1, Array[Byte]]
    Definition Classes
    Service
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. val serviceMap: HashMap[String, Service[(TProtocol, Int), Array[Byte]]]
    Attributes
    protected
  25. def serviceName: String
  26. def status: Status

    The current availability Status of this Service.

    The current availability Status of this Service.

    Definition Classes
    Service
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    Service → Function1 → AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Service[Array[Byte], Array[Byte]]

Inherited from Closable

Inherited from (Array[Byte]) ⇒ Future[Array[Byte]]

Inherited from AnyRef

Inherited from Any

Ungrouped