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.

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

   close closes the underlying service factory, which means that it won't be satisfied until after the underlying future has been satisfied.

   Note

   Implicitly masks the underlying future from interrupts. Promises are detached on interruption.

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.

   A service wrapper that expires the self service after a certain amount of idle time. By default, expiring calls .close() on the self channel, but this action is customizable.

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.

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

   This acts as a request driven circuit breaker.

   When used in a typical Finagle client, there is one instance per node and as such, the load balancer will avoid nodes that are marked down via failure accrual.

7. case class KetamaShardingServiceBuilder[Req, Rep](_nodes: Option[Seq[KetamaNode[Service[Req, Rep]]]] = None, _hash: Option[(Req) ⇒ Option[Long]] = 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.

   A com.twitter.finagle.Filter that uses an argument function to predicate whether or not to apply the subsequent com.twitter.finagle.Service. In cases where the function returns false, a the filter fails with a com.twitter.finagle.NotServableException.

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.

    Represents a request/response pair.

    For some protocols, like HTTP, these types are what you'd expect — com.twitter.finagle.http.Request and com.twitter.finagle.http.Response. While for other protocols that may not be the case. Please review the protocol's "com.twitter.finagle.$protocol.service.$ProtocolResponseClassifier" for details.

    See also

    com.twitter.finagle.thriftmux.service.ThriftMuxResponseClassifier

    com.twitter.finagle.http.service.HttpResponseClassifier

12. sealed trait ResponseClass extends AnyRef

    

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

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

    See also

    ResponseClassifier

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.

    Represents a budget for retrying requests.

    A retry budget is useful for attenuating the amplifying effects of many clients within a process retrying requests multiple times. This acts as a form of coordination between those retries.

    Implementations must be thread-safe.

    See also

    Retries for how budgets get translated into Filters.

    RetryBudget.apply for creating instances.

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.

    A com.twitter.finagle.Filter that coordinates retries of subsequent Services. Exceptional responses can can be classified as retryable via the retryPolicy argument com.twitter.finagle.service.RetryPolicy.

    Note

    consider using a Timer with high resolution so that there is less correlation between retries. For example HighResTimer.Default.

    See also

    RetryFilter for a version that allows for retries on "successful" responses as well as failures.

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

    

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

    A com.twitter.finagle.Filter that coordinates retries of subsequent Services. Successful and exceptional responses can be classified as retryable via the retryPolicy com.twitter.finagle.service.RetryPolicy argument.

    Note

    consider using a Timer with high resolution so that there is less correlation between retries. For example HighResTimer.Default.

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

    

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

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

    The Function1 returns None if no more retries should be made and Some if another retry should happen. The returned Some has a Duration field for how long to wait for the next retry as well as the next RetryPolicy to use.

    See also

    SimpleRetryPolicy for a Java friendly API.

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

    

    ShardingService takes a Distributor where the handle is a service.

    ShardingService takes a Distributor where the handle is a service. It uses the distributor to distribute requests *only* when the hash function returns Some[Long]. If None is returned, it throws NotShardableException. If the underlying service for a particular shard is not available, NotServableException is thrown. Example: val serviceFactory = KetamaShardingServiceBuilder() .nodes(services) // services is of type Seq[(String, Service[Req,Rep])] .withHash { req => Some(hashCodeOfSomething)} .buildFactory() val service = serviceFactory() service(req) // where req is a Req and may have ShardableRequest mixed in

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

    

    A retry policy abstract class.

    A retry policy abstract class. This is convenient to use for Java programmers. Simply implement the two abstract methods shouldRetry and backoffAt and you're good to go!

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

    

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

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

    Note that this factory builds new Services, so the "singleton" service argument is not shared by reference. This differs from com.twitter.finagle.ServiceFactory#const in that const proxies all requests to the same service rather than creating new objects.

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.

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

    Note

    The innocent bystander may find the semantics with respect to backup requests a bit puzzling; they are entangled in legacy. "requests" counts the total number of requests: subtracting "success" from this produces the failure count. However, this doesn't allow for "shadow" requests to be accounted for in "requests". This is why we don't modify metrics for backup request failures.

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.