Packages

  • package root
    Definition Classes
    root
  • package com

    Start with com.twitter.finagle.

    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 addr
    Definition Classes
    finagle
  • package builder
    Definition Classes
    finagle
  • package client
    Definition Classes
    finagle
  • package context
    Definition Classes
    finagle
  • package core
    Definition Classes
    finagle
  • package dispatch
    Definition Classes
    finagle
  • package exception
    Definition Classes
    finagle
  • package exp

    Package exp contains experimental code.

    Package exp contains experimental code. This can be removed or stabilized (moved elsewhere) at any time.

    Definition Classes
    finagle
  • package factory
    Definition Classes
    finagle
  • package filter
    Definition Classes
    finagle
  • package http
    Definition Classes
    finagle
  • package codec
  • package exp
  • package filter
  • package netty
  • package param
  • package path
  • package service
  • package util
  • Cookie
  • CookieMap
  • EmptyParamMap
  • Fields
  • FileElement
  • FormElement
  • HeaderMap
  • HttpMuxHandler
  • HttpMuxer
  • HttpMuxers
  • HttpTracing
  • MapParamMap
  • MediaType
  • Message
  • Method
  • MethodBuilder
  • Methods
  • ParamMap
  • ProxyCredentials
  • Request
  • RequestBuilder
  • RequestConfig
  • RequestParamMap
  • RequestProxy
  • Response
  • ResponseProxy
  • Route
  • RouteIndex
  • SimpleElement
  • SpnegoAuthenticator
  • Status
  • Statuses
  • TlsFilter
  • TooLongMessageException
  • Version
  • Versions
  • package http2
    Definition Classes
    finagle
  • package httpproxy
    Definition Classes
    finagle
  • package kestrel
    Definition Classes
    finagle
  • package liveness
    Definition Classes
    finagle
  • package loadbalancer

    This package implements client side load balancing algorithms.

    This package implements client side load balancing algorithms.

    As an end-user, see the Balancers API to create instances which can be used to configure a Finagle client with various load balancing strategies.

    As an implementor, each algorithm gets its own subdirectory and is exposed via the Balancers object. Several convenient traits are provided which factor out common behavior and can be mixed in (i.e. Balancer, DistributorT, NodeT, and Updating).

    Definition Classes
    finagle
  • package mdns
    Definition Classes
    finagle
  • package memcached
    Definition Classes
    finagle
  • package mux

    Package mux implements a generic RPC multiplexer with a rich protocol.

    Package mux implements a generic RPC multiplexer with a rich protocol. Mux is itself encoding independent, so it is meant to use as the transport for other RPC systems (eg. thrift). In OSI terminology, it is a pure session layer.

    In the below description, all numeric values are unsigned and in big-endian byte order. The schema size:4 body:10 defines the field size to be 4 bytes, followed by 10 bytes of the field body. The schema key~4 defines the field key to be defined by 4 bytes interpreted as the size of the field, followed by that many bytes comprising the field itself--it is shorthand for keysize:4 key:keysize. Groups are denoted by parenthesis; * denotes repetition of the previous schema 0 or more times, while {n} indicates repetition exactly n times. Unspecified sizes consume the rest of the frame: they may be specified only as the last field in the message.

    All strings in Mux are Utf-8 encoded, and are never null-terminated.

    Message framing

    Messages in mux are framed with a 4-byte big-endian size header, followed by 1 byte describing the message type and a 3-byte tag; or, diagrammatically: size:4 type:1 tag:3. The remainder of the frame (size-4 bytes) contains the body. Its format depends on the message type, documented below.

    Tag 0 designates a "marker" T message that expects no reply. Some messages may be split into an ordered sequence of fragments. Tag MSB=0 denotes the last message in such a sequence, making the tag namespace 23 bits. The tag is otherwise arbitrary, and is chosen by the sender of the T message.

    Currently, only Tdispatch and Rdispatch messages may be split into an ordered sequence of fragments. TdispatchError message ends a Tdispatch sequence and an Rerr ends an Rdispatch sequence.

    Message types, interpreted as a two's complement, 1-byte integer are numbered as follows: positive numbers are T-messages; their negative complement is the corresponding R message. T-messages greater than 63 (correspondingly R-messages smaller than -63) are session messages. The message number -128 is reserved for Rerr. All other messages are application messages. Middle boxes may forward application messages indiscriminately. Because of an early implementation bug, two aliases exist: 127 is Rerr, and -62 is Tdiscarded.

    The protocol is full duplex: both the server and client may send T messages initiating an exchange.

    Exchanges

    Messages are designated as "T messages" or "R messages", T and R being stand-ins for transmit and receive. A T message initiates an exchange and is assigned a free tag by the sender. A reply is either an R message of the same type (Rx replies to Tx for some x), or an Rerr, indicating a session layer error. R messages are matched to their T messages by tag, and the reply concludes the exchange and frees the tag for future use. Implementations should reuse small tag numbers.

    Messages

    size:4 Tinit:1 tag:3 version:2 (key~4 value~4)* reinitializes a session. Clients typically send this at the beginning of the session. When doing so, the sender may issue no more T messages until the corresponding size:4 Rinit:1 tag:3 version:2 (key~4 value~4)* has been received. After the Rinit was received, all connection state has been reset (outstanding tags are invalidated) and the stream is resumed according to the newly negotiated parameters. Prior to the first Tinit, the session operates at version 1. Rinit's version field is the accepted version of the session (which may be lower than the one requested by Tinit).

    size:4 Treq:1 tag:3 n:1 (key:1 value~1){n} body: initiates the request described by its body. The request body is delivered to the application. The request header contains a number of key-value pairs that describe request metadata.

    Keys for Treq messages are as follows:

    1. traceid: a 24-byte value describing the full Dapper trace id assigned by the client. The value's format is spanid:8 parentid:8 traceid:8.

    2. traceflag: a bitmask describing trace flags. Currently, the only defined flag is bit 0 which enables "debug mode", asking the server to force trace sampling.

    size:4 Tdispatch:1 tag:3 nctx:2 (ckey~2 cval~2){nc} dst~2 nd:2 (from~2 to~2){nd} body: implements destination dispatch. Tdispatch messages carry a set of keyed request contexts, followed by a logical destination encoded as a UTF-8 string. A delegation table follows describing rewrite rules that apply to this request.

    size:4 Rreq:1 tag:3 status:1 body: replies to a request. Status codes are as follows: 0=OK; the body contains the reply. 1=ERROR; the body contains a string describing the error. 2=NACK; a negative acknowledgment, the body contains a string describing the reason.

    size:4 Rdispatch:1 tag:3 status:1 nctx:2 (key~2 value~2){nctx} body: replies to a Tdispatch request. Status codes are as in Rreq. Replies can include request contexts. MuxFailure flags are currently sent via Rdispatch contexts under the "MuxFailure" key. See the MuxFailure flags section below.

    size:4 Rerr:1 tag:3 why: indicates that the corresponding T message produced an error. Rerr is specifically for server errors: the server failed to interpret or act on the message. The body carries a string describing the error.

    size:4 Tdrain:1 tag:3 is a request sent by the server telling the client to stop sending new requests. A client acknowledges this with an Rdrain message.

    size:4 Tping:1 tag:3 is sent by either party to check the liveness of its peer; these should be responded to immediately with a Rping message.

    size:4 Tdiscarded:1 tag:3 discard_tag:3 why: is a marker message and therefore has a tag value of 0. discard_tag indicates the tag of the Tdispatch to be discarded by the client. This can be used as a hint for early termination. Why is a string describing why the request was discarded. Note that it does *not* free the server from the obligation of replying to the original Treq.

    size:4 Tlease:1 tag:3 unit:1 howmuch:8 is a marker message indicating that a lease has been issued for howmuch units. As a marker message, its tag value must be 0. Unit '0' is reserved for duration in milliseconds. Whenever a lease has not been issued, a client can assume it holds an indefinite lease. Adhering to the lease is optional, but the server may reject requests or provide degraded service should the lease expire. This is used by servers to implement features like garbage collection avoidance.

    MuxFailure Flags

    Failure flags are read and written as an 8 byte integer. Unrecognized flags will be ignored silently, but should all be considered reserved for future use.

    Flag Value Meaning Restartable 1 << 0 Request is safe to re-issue Rejected 1 << 1 Request was rejected/Nacked by the server NonRetryable 1 << 2 Request should not be retried

    Definition Classes
    finagle
  • package mysql
    Definition Classes
    finagle
  • package namer
    Definition Classes
    finagle
  • package naming
    Definition Classes
    finagle
  • package netty3

    Package netty3 implements the bottom finagle primitives: {{com.twitter.finagle.Server}} and a client transport in terms of the netty3 event loop.

    Package netty3 implements the bottom finagle primitives: {{com.twitter.finagle.Server}} and a client transport in terms of the netty3 event loop.

    Note: when {{com.twitter.finagle.builder.ClientBuilder}} and {{com.twitter.finagle.builder.ServerBuilder}} are deprecated, package netty3 can move into its own package, so that only the (new-style) clients and servers that depend on netty3 bring it in.

    Definition Classes
    finagle
  • package netty4

    Package netty4 implements the bottom finagle primitives: com.twitter.finagle.Server and a client transport in terms of the netty4 event loop.

    Package netty4 implements the bottom finagle primitives: com.twitter.finagle.Server and a client transport in terms of the netty4 event loop.

    Definition Classes
    finagle
  • package param

    Defines common com.twitter.finagle.Stack.Param's shared between finagle clients and servers.

    Defines common com.twitter.finagle.Stack.Param's shared between finagle clients and servers.

    Definition Classes
    finagle
  • package pool
    Definition Classes
    finagle
  • package redis
    Definition Classes
    finagle
  • package server
    Definition Classes
    finagle
  • package serverset2
    Definition Classes
    finagle
  • package service
    Definition Classes
    finagle
  • package socks
    Definition Classes
    finagle
  • package ssl
    Definition Classes
    finagle
  • package stats
    Definition Classes
    finagle
  • package stream

    Finagle-stream implements a rather peculiar protocol: it streams discrete messages delineated by HTTP chunks.

    Finagle-stream implements a rather peculiar protocol: it streams discrete messages delineated by HTTP chunks. It isn't how we'd design a protocol to stream messages, but we are stuck with it for legacy reasons.

    Finagle-stream sessions are also one-shot: each session handles exactly one stream. The session terminates together with the stream.

    Definition Classes
    finagle
  • 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 thriftmux
    Definition Classes
    finagle
  • package toggle
    Definition Classes
    finagle
  • package tracing
    Definition Classes
    finagle
  • package transport
    Definition Classes
    finagle
  • package util
    Definition Classes
    finagle
  • package zipkin
    Definition Classes
    finagle
  • package zookeeper
    Definition Classes
    finagle

package http

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

Type Members

  1. class Cookie extends AnyRef

    Scala wrapper around Netty cookies.

  2. class CookieMap extends Map[String, Cookie] with MapLike[String, Cookie, CookieMap]

    Adapt cookies of a Message to a mutable Map where cookies are indexed by their name.

    Adapt cookies of a Message to a mutable Map where cookies are indexed by their name. Requests use the Cookie header and Responses use the Set-Cookie header. If a cookie is added to the CookieMap, a header is automatically added to the Message. You can add the same cookie more than once. Use getAll to retrieve all of them, otherwise only the first one is returned. If a cookie is removed from the CookieMap, a header is automatically removed from the message

  3. case class FileElement (name: String, content: Buf, contentType: Option[String] = None, filename: Option[String] = None) extends FormElement with Product with Serializable
  4. sealed abstract class FormElement extends AnyRef
  5. abstract class HeaderMap extends Map[String, String] with MapLike[String, String, HeaderMap]

    Mutable message headers map.

    Mutable message headers map.

    Header names are case-insensitive. For example, get("accept") is the same as get("Accept").

    The map is a multi-map. Use getAll to get all values for a key. Use add to append a key-value.

  6. trait HttpMuxHandler extends Service[Request, Response]

    Trait HttpMuxHandler is used for service-loading HTTP handlers.

  7. class HttpMuxer extends Service[Request, Response]

    A service that dispatches incoming requests to registered handlers.

    A service that dispatches incoming requests to registered handlers. In order to choose which handler to dispatch the request to, we take the path of the request and match it with the patterns of the pre-registered handlers. The pattern matching follows these rules:

    • Patterns ending with "/" use exclusive prefix matching. Eg: the pattern "foo/bar/" matches these paths: "foo/bar/", "foo/bar/baz", etc but NOT "foo/bar" Similarly, the pattern "/" matches all paths
    • Patterns not ending with "/" use exact matching. Eg: the pattern "foo/bar" ONLY matches this path: "foo/bar"
    • Special case: The pattern "" matches only "/" and ""

    NOTE: When multiple pattern matches exist, the longest pattern wins.

  8. class MapParamMap extends ParamMap

    Map-backed ParamMap.

  9. abstract class Message extends AnyRef

    Rich Message

    Rich Message

    Base class for Request and Response. There are both input and output methods, though only one set of methods should be used.

  10. final class Method extends AnyRef

    Represents the HTTP method.

    Represents the HTTP method.

    The method is a case-sensitive string defined as part of the request line of the HTTP protocol.

    See also

    https://tools.ietf.org/html/rfc7230#section-3.1.1

    For Java-friendly enums, see com.twitter.finagle.http.Methods.

  11. class MethodBuilder extends MethodBuilderScaladoc[MethodBuilder]

    Experimental: This API is under construction.

    Experimental: This API is under construction.

    Example:
    1. A client that has timeouts and retries on a 418 status code.

      import com.twitter.conversions.time._
      import com.twitter.finagle.Http
      import com.twitter.finagle.service.{ReqRep, ResponseClass}
      import com.twitter.util.Return
      
      val client: Http.Client = ???
      client.methodBuilder("inet!example.com:80")
        .withTimeoutPerRequest(50.milliseconds)
        .withTimeoutTotal(100.milliseconds)
        .withRetryForClassifier {
          case ReqRep(_, Return(rep)) if rep.statusCode == 418 => ResponseClass.RetryableFailure
        }
        .newService("an_endpoint_name")
    See also

    user guide and client.MethodBuilderScaladoc for documentation.

    com.twitter.finagle.Http.Client.methodBuilder to construct instances.

  12. abstract class ParamMap extends Map[String, String] with MapLike[String, String, ParamMap]

    Request parameter map.

    Request parameter map.

    This is a persistent (immutable) multi-map.

    Use getAll() to get all values for a key.

  13. case class ProxyCredentials (username: String, password: String) extends Product with Serializable
  14. abstract class Request extends Message

    Rich HttpRequest.

    Rich HttpRequest.

    Use RequestProxy to create an even richer subclass.

  15. class RequestBuilder [HasUrl, HasForm] extends AnyRef
  16. class RequestParamMap extends ParamMap

    HttpRequest-backed param map.

    HttpRequest-backed param map. Handle parameters in the URL and form encoded body. Multipart forms are not supported (not needed, could be abusive).

    This map is a multi-map. Use getAll() to get all values for a key.

  17. abstract class RequestProxy extends Request

    Proxy for Request.

    Proxy for Request. This can be used to create a richer request class that wraps Request without exposing the underlying netty http type.

  18. abstract class Response extends Message

    Rich HttpResponse

  19. abstract class ResponseProxy extends Response
  20. case class Route (pattern: String, handler: Service[Request, Response], index: Option[RouteIndex] = None) extends Product with Serializable

    Represents an element which can be routed to via the HttpMuxer.

    Represents an element which can be routed to via the HttpMuxer.

    pattern

    The pattern the handler is bound to. This is also often used as the path to access the route, but if something more detailed is required, the RouteIndex.path parameter can be used.

    handler

    The service which requests are routed to.

    index

    Optionally contains information for the route UI.

  21. case class RouteIndex (alias: String, group: String, path: Option[String] = None, method: Method = Get) extends Product with Serializable

    Contains the route UI information.

    Contains the route UI information.

    alias

    A short name used to identify the route when listed in index.

    group

    A grouping used to organize the route in the index. Routes with the same grouping are displayed together.

    path

    The path used to access the route. A request is routed to the path as per the com.twitter.finagle.http.HttpMuxer spec. The path only needs to be specified if the URL accessed in the admin interface is different from the pattern provided in Route.pattern.

    method

    Specifies which HTTP Method to use from com.twitter.finagle.http.Method. The default is Method.Get. Only Method.Get and Method.Post are supported.

  22. case class SimpleElement (name: String, content: String) extends FormElement with Product with Serializable
  23. case class Status (code: Int) extends Product with Serializable

    Represents an HTTP status code.

    Represents an HTTP status code.

    The set of commonly known HTTP status codes have an associated reason phrase (see reasons). We don't provide a way to set the reason phrase because:

    - it simplifies construction (users only supply the code) - it avoids the need to validate user-defined reason phrases - it omits the possibility of statuses with duplicate reason phrases

    The only downside is that we lose the ability to create custom statuses with "vanity" reason phrases, but this should be tolerable.

    For Java-friendly enums, see com.twitter.finagle.http.Statuses.

  24. class TlsFilter extends SimpleFilter[Request, Response]

    Adds the host headers to for TLS-enabled requests.

  25. final class TooLongMessageException extends ChannelException with FailureFlags[TooLongMessageException]

    The Message was too long to be handled correctly

  26. final case class Version extends Product with Serializable

    Represents the HTTP version.

    Represents the HTTP version.

    For Java-friendly enums, see com.twitter.finagle.http.Versions.

  27. final class Methods extends AnyRef

    Java friendly versions of com.twitter.finagle.http.Method.

    Java friendly versions of com.twitter.finagle.http.Method.

    Deprecated

    as of 2017-02-13. Please use the com.twitter.finagle.http.Method instances directly.

  28. final class Statuses extends AnyRef

    Java friendly versions of com.twitter.finagle.http.Status.

    Java friendly versions of com.twitter.finagle.http.Status.

    Deprecated

    as of 2017-02-13. Please use the com.twitter.finagle.http.Status instances directly.

  29. final class Versions extends AnyRef

    Java friendly versions of com.twitter.finagle.http.Version.

    Java friendly versions of com.twitter.finagle.http.Version.

    Deprecated

    as of 2017-02-13. Please use the com.twitter.finagle.http.Version instances directly.

Value Members

  1. object EmptyParamMap extends ParamMap

    Empty ParamMap

  2. object Fields
  3. object HeaderMap
  4. object HttpMuxer extends Service[Request, Response]

    Singleton default multiplex service.

    Singleton default multiplex service.

    See also

    HttpMuxers for Java compatibility APIs.

  5. object HttpMuxers

    Java compatibility APIs for HttpMuxer.

  6. object HttpTracing
  7. object MapParamMap
  8. object MediaType
  9. object Message
  10. object Method
  11. object MethodBuilder

    Experimental: This API is under construction.

  12. object ParamMap
  13. object ProxyCredentials extends Serializable
  14. object Request
  15. object RequestBuilder

    Factory for com.twitter.finagle.http.RequestBuilder instances

  16. object RequestConfig extends Serializable
  17. object Response
  18. object SpnegoAuthenticator

    A SPNEGO HTTP authenticator as defined in https://tools.ietf.org/html/rfc4559, which gets its credentials from a provided CredentialSource...

    A SPNEGO HTTP authenticator as defined in https://tools.ietf.org/html/rfc4559, which gets its credentials from a provided CredentialSource... usually JAAS.

  19. object Status extends Serializable
  20. object TlsFilter
  21. object TooLongMessageException extends Serializable
  22. object Version extends Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped