service

Type Members

1. class ConstantService[Req, Rep] extends Service[Req, Rep]

   A com.twitter.finagle.Service that returns a constant result.

2. class DelayedFactory[Req, Rep] extends ServiceFactory[Req, Rep]

   A factory that won't satisfy the service future until an underlying service factory is ready.

3. abstract class ExpiringService[Req, Rep] extends ServiceProxy[Req, Rep]

   A service wrapper that expires the self service after a certain amount of idle time.

4. class FailedService extends ConstantService[Any, Nothing]

   A com.twitter.finagle.Service that fails with a constant Throwable.

5. class FailingFactory[Req, Rep] extends ServiceFactory[Req, Rep]

   A com.twitter.finagle.ServiceFactory that fails to construct services.

6. class FailureAccrualFactory[Req, Rep] extends ServiceFactory[Req, Rep]

   A com.twitter.finagle.ServiceFactory that accrues failures, marking itself unavailable when deemed unhealthy according to its configuration.

7. case class KetamaShardingServiceBuilder[Req, Rep](_nodes: Option[Seq[KetamaNode[Service[Req, Rep]]]] = scala.None, _hash: Option[(Req) ⇒ Option[Long]] = scala.None, _numReps: Int = 160) extends Product with Serializable

8. class LocalRateLimitingStrategy[Req] extends (Req) ⇒ Future[Boolean]

   Strategy responsible for tracking requests and computing rate per client.

9. class OptionallyServableFilter[Req, Rep] extends SimpleFilter[Req, Rep]

   A com.twitter.finagle.Filter that uses an argument function to predicate whether or not to apply the subsequent com.twitter.finagle.Service.

10. class RateLimitingFilter[Req, Rep] extends SimpleFilter[Req, Rep]

    A com.twitter.finagle.Filter that accepts or refuses requests based on a rate limiting strategy.

11. case class ReqRep(request: Any, response: Try[Any]) extends Product with Serializable

    Represents a request/response pair.

12. sealed trait ResponseClass extends AnyRef

    A classification of the result of a request/response pair.

13. final class ResponseClasses extends AnyRef

14. type ResponseClassifier = PartialFunction[ReqRep, ResponseClass]

    A response classifier allows developers to give Finagle the additional application specific knowledge necessary in order to properly classify them.

    A response classifier allows developers to give Finagle the additional application specific knowledge necessary in order to properly classify them. Without this, Finagle can only safely make judgements about transport level failures.

    As an example take an HTTP client that receives a response with a 500 status code back from a server. To Finagle this is a successful request/response based solely on the transport level. The application developer may want to treat all 500 status codes as failures and can do so via a com.twitter.finagle.service.ResponseClassifier.

    It is a PartialFunction from a request/response pair to a ResponseClass and as such multiple classifiers can be composed together via PartialFunction.orElse.

    Note

    it is a good practice for users of ResponseClassifier.apply to instead use theClassifier.applyOrElse(input, ResponseClassifier.Default) in order to ensure that the PartialFunction will be fully covering.

    ,

    Finagle's default classifier is com.twitter.finagle.service.ResponseClassifier.Default which is a total function fully covering the input domain.

    ,

    Java does not understand the type alias and must be used as PartialFunction in Java.

    See also

    com.twitter.finagle.http.service.HttpResponseClassifier for some HTTP classification tools.

15. trait RetryBudget extends AnyRef

    Represents a budget for retrying requests.

16. final class RetryBudgets extends AnyRef

17. final class RetryExceptionsFilter[Req, Rep] extends RetryFilter[Req, Rep]

    A com.twitter.finagle.Filter that coordinates retries of subsequent Services.

18. class RetryFilter[Req, Rep] extends Filter[Req, Rep, Req, Rep]

    A com.twitter.finagle.Filter that coordinates retries of subsequent Services.

19. abstract class RetryPolicy[-A] extends (A) ⇒ Option[(Duration, RetryPolicy[A])]

    A function defining retry behavior for a given value type A.

20. class ShardingService[Req, Rep] extends Service[Req, Rep]

    ShardingService takes a Distributor where the handle is a service.

21. abstract class SimpleRetryPolicy[A] extends RetryPolicy[A] with (A) ⇒ Option[(Duration, RetryPolicy[A])]

    A retry policy abstract class.

22. class SingletonFactory[Req, Rep] extends ServiceFactory[Req, Rep]

    A com.twitter.finagle.ServiceFactory that produces Services identical to the argument service.

23. class StatsFilter[Req, Rep] extends SimpleFilter[Req, Rep]

    A StatsFilter reports request statistics including number of requests, number successful and request latency to the given StatsReceiver.

24. class StatsServiceFactory[Req, Rep] extends ServiceFactoryProxy[Req, Rep]

25. class TimeoutFilter[Req, Rep] extends SimpleFilter[Req, Rep]

    A com.twitter.finagle.Filter that applies a global timeout to requests.