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
  • ClientMonitorFactory
  • ExceptionReporter
  • MonitorFactory
  • NullMonitorFactory
  • Reporter
  • ServerMonitorFactory
  • host

sealed case class Reporter(client: Scribe[Future], serviceName: String, statsReceiver: StatsReceiver = NullStatsReceiver, sourceAddress: Option[String] = ..., clientAddress: Option[String] = None) extends Monitor with Product with Serializable

An implementation of ExceptionReceiver custom to the chickadee reporting service.

Optionally logs stats to a statsReceiver if desired.

Note that this implementation does not guarantee that a logged exception will be received by the configured scribe endpoint because it just drops a failed message and does not retry. This is because it is intended to log to a local (i.e. on the same machine) scribe daemon, in which case there should be no network failure. If there is failure in this case, something else is very wrong!

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Reporter
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Monitor
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Reporter(client: Scribe[Future], serviceName: String, statsReceiver: StatsReceiver = NullStatsReceiver, sourceAddress: Option[String] = ..., clientAddress: Option[String] = None)

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 andThen(next: Monitor): Monitor
    Definition Classes
    Monitor
  5. def apply(f: ⇒ Unit): Unit
    Definition Classes
    Monitor
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val client: Scribe[Future]
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def createEntry(e: Throwable): LogEntry

    Create a default ServiceException and fold in the modifiers (i.e.

    Create a default ServiceException and fold in the modifiers (i.e. to add a source/client endpoint).

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def handle(t: Throwable): Boolean

    Log an exception to the specified scribe endpoint.

    Log an exception to the specified scribe endpoint.

    See top level comment for this class for more details on performance implications.

    Definition Classes
    Reporter → Monitor
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def orElse(next: Monitor): Monitor
    Definition Classes
    Monitor
  19. val serviceName: String
  20. val statsReceiver: StatsReceiver
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def tryHandle(exc: Throwable): Try[Unit]
    Attributes
    protected
    Definition Classes
    Monitor
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  26. def withClient(address: InetAddress = InetAddress.getLoopbackAddress): Reporter

    Add a modifier to append a client address (i.e.

    Add a modifier to append a client address (i.e. endpoint) to a generated ServiceException.

    The endpoint string is the ip address of the host (e.g. "127.0.0.1").

  27. def withSource(address: SocketAddress): Reporter

    Add a modifier to append a source address (i.e.

    Add a modifier to append a source address (i.e. endpoint) to a generated ServiceException.

    The endpoint string is the ip of the host concatenated with the port of the socket (e.g. "127.0.0.1:8080"). This is retained for orthogonality of exterior interfaces. We use the host name internaly.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Monitor

Inherited from AnyRef

Inherited from Any

Ungrouped