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 service
    Definition Classes
    finagle
  • object DeadlineFilter

    DeadlineFilter provides an admission control module that can be pushed onto the stack to reject requests with expired deadlines (deadlines are set in the TimeoutFilter).

    DeadlineFilter provides an admission control module that can be pushed onto the stack to reject requests with expired deadlines (deadlines are set in the TimeoutFilter). For servers, DeadlineFilter.module should be pushed onto the stack before the stats filters so stats are recorded for the request, and pushed after TimeoutFilter where a new Deadline is set. For clients, DeadlineFilter.module should be pushed before the stats filters; higher in the stack is preferable so requests are rejected as early as possible.

    Definition Classes
    service
    Note

    Deadlines cross process boundaries and can span multiple nodes in a call graph. Even if a direct caller doesn't set a deadline, the server may still receive one and thus potentially fail the request. It is advised that all clients in the call graph be well prepared to handle NACKs before using this.

  • DeadlineExceededException
  • MaxRejectFraction
  • Mode
  • RejectPeriod
c

com.twitter.finagle.service.DeadlineFilter

DeadlineExceededException

class DeadlineExceededException extends Exception with FailureFlags[DeadlineExceededException] with HasLogLevel

Linear Supertypes
HasLogLevel, FailureFlags[DeadlineExceededException], Exception, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DeadlineExceededException
  2. HasLogLevel
  3. FailureFlags
  4. Exception
  5. Throwable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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 addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def asNonRetryable: DeadlineExceededException

    This as a non-retryable failure.

    This as a non-retryable failure. This does not mutate.

    Definition Classes
    FailureFlags
  7. def asRejected: DeadlineExceededException

    This as a rejected failure.

    This as a rejected failure. This does not mutate.

    Definition Classes
    FailureFlags
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def copyWithFlags(flags: Long): DeadlineExceededException

    A copy of this object with the given flags replacing the current flags.

    A copy of this object with the given flags replacing the current flags. The caller of this method should check to see if a copy is necessary before calling.

    As this is an internal API, the other Throwable fields such as the cause and stack trace should be handled by callers.

    Attributes
    protected
    Definition Classes
    DeadlineExceededExceptionFailureFlags
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. val flags: Long
  15. def getCause(): Throwable
    Definition Classes
    Throwable
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  18. def getMessage(): String
    Definition Classes
    Throwable
  19. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  20. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  23. def isFlagged(which: Long): Boolean

    Test if this is flagged with a particular set of flags

    Test if this is flagged with a particular set of flags

    Definition Classes
    FailureFlags
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def logLevel: Level
    Definition Classes
    DeadlineExceededException → HasLogLevel
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  30. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  31. def printStackTrace(): Unit
    Definition Classes
    Throwable
  32. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  33. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  34. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from HasLogLevel

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped