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 toggle
    Definition Classes
    finagle
  • package flag
    Definition Classes
    toggle
  • JsonToggleMap
  • NullToggleMap
  • ServiceLoadedToggleMap
  • StandardToggleMap
  • Toggle
  • ToggleMap

object JsonToggleMap

ToggleMaps in JSON format.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonToggleMap
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. sealed abstract class DescriptionMode extends AnyRef

    How to treat the "description" field on a toggle.

    How to treat the "description" field on a toggle.

    See also

    DescriptionIgnored and DescriptionRequired.

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def mutableToJson(registry: Map[String, Mutable]): String

    Serialize a ToggleMap to JSON format

    Serialize a ToggleMap to JSON format

    Note

    this is a helper for Java friendliness. Scala users should continue to use toJson.

  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def parse(url: URL, descriptionMode: DescriptionMode): Try[ToggleMap]

    Attempts to parse the given JSON URL into a ToggleMap.

    Attempts to parse the given JSON URL into a ToggleMap.

    Useful for loading resource files via StandardToggleMap.

    The JSON Schema used is:

    {
  "$schema": "https://json-schema.org/draft-04/schema#",
  "type": "object",
  "required": [
    "toggles"
  ],
  "properties": {
    "toggles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "description": { "type": "string" },
          "fraction": {
            "type": "number",
            "minimum": 0.0,
            "maximum": 1.0,
            "exclusiveMinimum": false,
            "exclusiveMaxmimum": false
          },
          "comment": { "type": "string" }
        },
        "required": [
          "id",
          "fraction"
        ]
      }
    }
  }
}

    Here is an example of a JSON ToggleMap input:

    {
  "toggles": [
    {
      "id": "com.game.of.thrones.WargingEnabled",
      "description": "Use warging for computing the response.",
      "fraction": 0.1
    },
    {
      "id": "com.game.of.thrones.IsWinterComing",
      "description": "Controls whether or not winter is coming.",
      "fraction": 1.0,
      "comment": "We've seen the white walkers, we know that winter is coming."
    }
  ]
}

    With the exception of "comment", the properties correspond to the various fields on Toggle.Metadata.

    • name: Corresponds to Toggle.Metadata.id.
    • fraction: Corresponds to Toggle.Metadata.fraction and values must be between 0.0 and 1.0, inclusive.
    • description: Corresponds to Toggle.Metadata.description.
    • comment: For documentation purposes only and is not used in the creation of the ToggleMap.
    descriptionMode

    how to treat the "description" field for a toggle.

  17. def parse(json: String, descriptionMode: DescriptionMode): Try[ToggleMap]

    Attempts to parse the given JSON String into a ToggleMap.

    Attempts to parse the given JSON String into a ToggleMap.

    The JSON Schema used is:

    {
  "$schema": "https://json-schema.org/draft-04/schema#",
  "type": "object",
  "required": [
    "toggles"
  ],
  "properties": {
    "toggles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "description": { "type": "string" },
          "fraction": {
            "type": "number",
            "minimum": 0.0,
            "maximum": 1.0,
            "exclusiveMinimum": false,
            "exclusiveMaxmimum": false
          },
          "comment": { "type": "string" }
        },
        "required": [
          "id",
          "fraction"
        ]
      }
    }
  }
}

    Here is an example of a JSON ToggleMap input:

    {
  "toggles": [
    {
      "id": "com.game.of.thrones.WargingEnabled",
      "description": "Use warging for computing the response.",
      "fraction": 0.1
    },
    {
      "id": "com.game.of.thrones.IsWinterComing",
      "description": "Controls whether or not winter is coming.",
      "fraction": 1.0,
      "comment": "We've seen the white walkers, we know that winter is coming."
    }
  ]
}

    With the exception of "comment", the properties correspond to the various fields on Toggle.Metadata.

    • name: Corresponds to Toggle.Metadata.id.
    • fraction: Corresponds to Toggle.Metadata.fraction and values must be between 0.0 and 1.0, inclusive.
    • description: Corresponds to Toggle.Metadata.description.
    • comment: For documentation purposes only and is not used in the creation of the ToggleMap.
    descriptionMode

    how to treat the "description" field for a toggle.

  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toJson(registry: Map[String, ToggleMap]): String

    Serialize a ToggleMap to JSON format

  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. object DescriptionIgnored extends DescriptionMode

    Transforms the Toggle's "description" field into being empty.

    Transforms the Toggle's "description" field into being empty.

    This is useful for service owner overrides of a toggle where the developer making modifications is not the one who has defined the toggle itself.

  25. object DescriptionRequired extends DescriptionMode

    Requires toggles to have a "description" field.

    Requires toggles to have a "description" field.

    This is useful for the library owner's base definitions of Toggle.

Inherited from AnyRef

Inherited from Any

Ungrouped