Object

com.twitter.finagle.thrift.service

ThriftResponseClassifier

Related Doc: package service

Permalink

object ThriftResponseClassifier

ResponseClassifiers for use with finagle-thrift request/responses.

Thrift (and ThriftMux) services are a bit unusual in that there is only a single Service from Array[Byte] to Array[Byte] for all the methods of an IDL's service.

Thrift classifiers should be written in terms of the Scrooge generated request $Service.$Method.Args type and the method's response type. This is because there is support in Scrooge and Thrift.newService/newClient to deserialize the responses into the expected application types so that classifiers can be written in a normal way.

Given an idl: 

exception NotFoundException { 1: string reason }
exception RateLimitedException { 1: string reason }

service SocialGraph {
  i32 follow(1: i64 follower, 2: i64 followee) throws (
    1: NotFoundException ex, 2: RateLimitedException ex
  )
}

One possible custom classifier would be:

val classifier: ResponseClassifier = {
  case ReqRep(_, Throw(_: RateLimitedException)) => RetryableFailure
  case ReqRep(_, Throw(_: NotFoundException)) => NonRetryableFailure
  case ReqRep(_, Return(x: Int)) if x == 0 => NonRetryableFailure
  case ReqRep(SocialGraph.Follow.Args(a, b), _) if a <= 0 || b <= 0 => NonRetryableFailure // avoid this style!
}

Often times, a good default classifier is ThriftResponseClassifier.ThriftExceptionsAsFailures which treats any Thrift response that deserializes into an Exception as a non-retryable failure.

See also

The user guide for more information on Response Classification of Thrift and ThriftMux Clients and Servers.

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

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. val ThriftExceptionsAsFailures: ResponseClassifier

    Permalink

    Categorizes responses where the deserialized response is a Thrift Exception as a ResponseClass.NonRetryableFailure.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped