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

trait LogEntry extends ThriftStruct with Product2[String, String] with HasThriftStructCodec3[LogEntry] with Serializable

Prefer the companion object's com.twitter.finagle.zipkin.thriftscala.LogEntry.apply for construction if you don't need to specify passthrough fields.

Linear Supertypes
Serializable, HasThriftStructCodec3[LogEntry], Product2[String, String], Product, Equals, ThriftStruct, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LogEntry
  2. Serializable
  3. HasThriftStructCodec3
  4. Product2
  5. Product
  6. Equals
  7. ThriftStruct
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def category: String
  2. abstract def message: String

Concrete 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: String
    Definition Classes
    LogEntry → Product2
  5. def _2: String
    Definition Classes
    LogEntry → Product2
  6. def _codec: ThriftStructCodec3[LogEntry]
    Definition Classes
    LogEntry → HasThriftStructCodec3
  7. def _passthroughFields: Map[Short, TFieldBlob]
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def canEqual(other: Any): Boolean
    Definition Classes
    LogEntry → Equals
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  11. def copy(category: String = this.category, message: String = this.message, _passthroughFields: Map[Short, TFieldBlob] = this._passthroughFields): LogEntry
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(other: Any): Boolean
    Definition Classes
    LogEntry → Equals → AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def getFieldBlob(_fieldId: Short): Option[TFieldBlob]

    Gets a field value encoded as a binary blob using TCompactProtocol.

    Gets a field value encoded as a binary blob using TCompactProtocol. If the specified field is present in the passthrough map, that value is returned. Otherwise, if the specified field is known and not optional and set to None, then the field is serialized and returned.

  17. def getFieldBlobs(ids: TraversableOnce[Short]): Map[Short, TFieldBlob]

    Collects TCompactProtocol-encoded field values according to getFieldBlob into a map.

  18. def hashCode(): Int
    Definition Classes
    LogEntry → AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def productArity: Int
    Definition Classes
    LogEntry → Product2 → Product
  24. def productElement(n: Int): Any
    Definition Classes
    LogEntry → Product2 → Product
  25. def productIterator: Iterator[Any]
    Definition Classes
    Product
  26. def productPrefix: String
    Definition Classes
    LogEntry → Product
  27. def setField(_blob: TFieldBlob): LogEntry

    Sets a field using a TCompactProtocol-encoded binary blob.

    Sets a field using a TCompactProtocol-encoded binary blob. If the field is a known field, the blob is decoded and the field is set to the decoded value. If the field is unknown and passthrough fields are enabled, then the blob will be stored in _passthroughFields.

  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    LogEntry → AnyRef → Any
  30. def toTuple: (String, String)
  31. def unsetCategory: LogEntry

    If the specified field is optional, it is set to None.

    If the specified field is optional, it is set to None. Otherwise, if the field is known, it is reverted to its default value; if the field is unknown, it is removed from the passthroughFields map, if present.

  32. def unsetField(_fieldId: Short): LogEntry

    If the specified field is optional, it is set to None.

    If the specified field is optional, it is set to None. Otherwise, if the field is known, it is reverted to its default value; if the field is unknown, it is removed from the passthroughFields map, if present.

  33. def unsetMessage: LogEntry
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  37. def write(_oprot: TProtocol): Unit
    Definition Classes
    LogEntry → ThriftStruct

Inherited from Serializable

Inherited from HasThriftStructCodec3[LogEntry]

Inherited from Product2[String, String]

Inherited from Product

Inherited from Equals

Inherited from ThriftStruct

Inherited from AnyRef

Inherited from Any

Ungrouped