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 exception
    Definition Classes
    finagle
  • package thriftscala
    Definition Classes
    exception
  • object Scribe
    Definition Classes
    thriftscala
  • object Log extends ThriftMethod
    Definition Classes
    Scribe
  • Args
  • Result

class Result extends ThriftResponse[ResultCode] with ThriftStruct with Product1[Option[ResultCode]] with HasThriftStructCodec3[Result] with Serializable

Linear Supertypes
Serializable, HasThriftStructCodec3[Result], Product1[Option[ResultCode]], Product, Equals, ThriftStruct, ThriftResponse[ResultCode], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Result
  2. Serializable
  3. HasThriftStructCodec3
  4. Product1
  5. Product
  6. Equals
  7. ThriftStruct
  8. ThriftResponse
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Result(success: Option[ResultCode] = _root_.scala.None)
  2. new Result(success: Option[ResultCode], _passthroughFields: Map[Short, TFieldBlob])

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 _1: Option[ResultCode]
    Definition Classes
    Result → Product1
  5. def _codec: ThriftStructCodec3[Result]
    Definition Classes
    Result → HasThriftStructCodec3
  6. val _passthroughFields: Map[Short, TFieldBlob]
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def canEqual(other: Any): Boolean
    Definition Classes
    Result → Equals
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  10. def copy(success: Option[ResultCode] = this.success, _passthroughFields: Map[Short, TFieldBlob] = this._passthroughFields): Result
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(other: Any): Boolean
    Definition Classes
    Result → Equals → AnyRef → Any
  13. def exceptionFields: Iterable[Option[ThriftException]]
    Definition Classes
    Result → ThriftResponse
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def firstException(): Option[ThriftException]
    Definition Classes
    ThriftResponse
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    Result → AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  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. def productArity: Int
    Definition Classes
    Result → Product1 → Product
  23. def productElement(n: Int): Any
    Definition Classes
    Result → Product1 → Product
  24. def productIterator: Iterator[Any]
    Definition Classes
    Product
  25. def productPrefix: String
    Definition Classes
    Result → Product
  26. val success: Option[ResultCode]
  27. def successField: Option[ResultCode]
    Definition Classes
    Result → ThriftResponse
  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    Result → AnyRef → Any
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  33. def write(_oprot: TProtocol): Unit
    Definition Classes
    Result → ThriftStruct

Inherited from Serializable

Inherited from HasThriftStructCodec3[Result]

Inherited from Product1[Option[ResultCode]]

Inherited from Product

Inherited from Equals

Inherited from ThriftStruct

Inherited from ThriftResponse[ResultCode]

Inherited from AnyRef

Inherited from Any

Ungrouped