Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package twitter

    Start with com.twitter.finagle.

    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 thriftscala
    Definition Classes
    thrift
  • object Endpoint extends ValidatingThriftStructCodec3[Endpoint] with StructBuilderFactory[Endpoint] with Serializable

    Indicates the network context of a service recording an annotation with two exceptions.

    Indicates the network context of a service recording an annotation with two exceptions.

    When a BinaryAnnotation, and key is CLIENT_ADDR or SERVER_ADDR, the endpoint indicates the source or destination of an RPC. This exception allows zipkin to display network context of uninstrumented services, or clients such as web browsers.

    Definition Classes
    thriftscala
  • Immutable

class Immutable extends Endpoint

The default read-only implementation of Endpoint. You typically should not need to directly reference this class; instead, use the Endpoint.apply method to construct new instances.

Linear Supertypes
Endpoint, Serializable, ValidatingThriftStruct[Endpoint], HasThriftStructCodec3[Endpoint], Product3[Int, Short, String], Product, Equals, ThriftStruct, ThriftStructIface, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Immutable
  2. Endpoint
  3. Serializable
  4. ValidatingThriftStruct
  5. HasThriftStructCodec3
  6. Product3
  7. Product
  8. Equals
  9. ThriftStruct
  10. ThriftStructIface
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Immutable(ipv4: Int, port: Short, serviceName: String)
  2. new Immutable(ipv4: Int, port: Short, serviceName: String, _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: Int
    Definition Classes
    Endpoint → Product3
  5. def _2: Short
    Definition Classes
    Endpoint → Product3
  6. def _3: String
    Definition Classes
    Endpoint → Product3
  7. def _codec: ValidatingThriftStructCodec3[Endpoint]
    Definition Classes
    Endpoint → ValidatingThriftStruct → HasThriftStructCodec3
  8. val _passthroughFields: Map[Short, TFieldBlob]
    Definition Classes
    Immutable → Endpoint
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def canEqual(other: Any): Boolean
    Definition Classes
    Endpoint → Equals
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  12. def copy(ipv4: Int = this.ipv4, port: Short = this.port, serviceName: String = this.serviceName, _passthroughFields: Map[Short, TFieldBlob] = this._passthroughFields): Endpoint
    Definition Classes
    Endpoint
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(other: Any): Boolean
    Definition Classes
    Endpoint → Equals → AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. 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.

    Definition Classes
    Endpoint
  18. def getFieldBlobs(ids: TraversableOnce[Short]): Map[Short, TFieldBlob]

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

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

    Definition Classes
    Endpoint
  19. def hashCode(): Int
    Definition Classes
    Endpoint → AnyRef → Any
  20. val ipv4: Int
    Definition Classes
    Immutable → Endpoint
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def newBuilder(): StructBuilder[Endpoint]
    Definition Classes
    Endpoint
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. val port: Short
    Definition Classes
    Immutable → Endpoint
  27. def productArity: Int
    Definition Classes
    Product3 → Product
  28. def productElement(n: Int): Any
    Definition Classes
    Product3 → Product
    Annotations
    @throws(classOf[java.lang.IndexOutOfBoundsException])
  29. def productElementName(n: Int): String
    Definition Classes
    Product
  30. def productElementNames: Iterator[String]
    Definition Classes
    Product
  31. def productIterator: Iterator[Any]
    Definition Classes
    Product
  32. def productPrefix: String
    Definition Classes
    Endpoint → Product
  33. val serviceName: String
    Definition Classes
    Immutable → Endpoint
  34. def setField(_blob: TFieldBlob): Endpoint

    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.

    Definition Classes
    Endpoint
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. def toString(): String
    Definition Classes
    Endpoint → AnyRef → Any
  37. def toTuple: (Int, Short, String)
    Definition Classes
    Endpoint
  38. def unsetField(_fieldId: Short): Endpoint

    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.

    Definition Classes
    Endpoint
  39. def unsetIpv4: Endpoint

    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.

    Definition Classes
    Endpoint
  40. def unsetPort: Endpoint
    Definition Classes
    Endpoint
  41. def unsetServiceName: Endpoint
    Definition Classes
    Endpoint
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  45. def write(_oprot: TProtocol): Unit
    Definition Classes
    Endpoint → ThriftStruct

Inherited from Endpoint

Inherited from Serializable

Inherited from ValidatingThriftStruct[Endpoint]

Inherited from HasThriftStructCodec3[Endpoint]

Inherited from Product3[Int, Short, String]

Inherited from Product

Inherited from Equals

Inherited from ThriftStruct

Inherited from ThriftStructIface

Inherited from AnyRef

Inherited from Any

Ungrouped