class DeadlineFilter[Req, Rep] extends SimpleFilter[Req, Rep]
A com.twitter.finagle.Filter that rejects requests when their deadline has passed.
- See also
The user guide for more details.
- Alphabetic
- By Inheritance
- DeadlineFilter
- SimpleFilter
- Filter
- Function2
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DeadlineFilter(rejectPeriod: Duration, maxRejectFraction: Double, statsReceiver: StatsReceiver, nowMillis: () => Long)
- new DeadlineFilter(rejectPeriod: Duration = DeadlineFilter.DefaultRejectPeriod, maxRejectFraction: Double = DeadlineFilter.DefaultMaxRejectFraction, statsReceiver: StatsReceiver, nowMillis: () => Long = Stopwatch.systemMillis, metricsRegistry: Option[CoreMetricsRegistry] = None, isDarkMode: Boolean, sourceRole: String = "")
- rejectPeriod
No more than
maxRejectFractionof requests will be discarded over therejectPeriod. Must be>= 1 secondand<= 60 seconds. Default is 10.seconds.- maxRejectFraction
Maximum fraction of requests per-connection that can be rejected over
rejectPeriod. Must be between 0.0 and 1.0. Default is 0.2.- statsReceiver
for stats reporting, typically scoped to ".../admission_control/deadline/"
- nowMillis
current time in milliseconds
- metricsRegistry
an optional [CoreMetricsRegistry] set by stack parameter for injecting metrics and instrumenting top-line expressions
- isDarkMode
DarkMode will collect stats but not reject requests
- sourceRole
an optional param provides a prefix for deadline traces, typically "srv/" for server side filters and "clnt/" for client side
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def agnosticAndThen(next: TypeAgnostic): Filter[Req, Rep, Req, Rep]
Convert the Filter.TypeAgnostic filter to a Filter and chain it with
andThen.Convert the Filter.TypeAgnostic filter to a Filter and chain it with
andThen.- Definition Classes
- Filter
- def andThen(factory: ServiceFactory[Req, Rep]): ServiceFactory[Req, Rep]
Terminates a filter chain in a ServiceFactory.
Terminates a filter chain in a ServiceFactory. For example,
myFilter.andThen(myServiceFactory)
- factory
a service factory that takes the output request type and the input response type.
- Definition Classes
- Filter
- def andThen(service: Service[Req, Rep]): Service[Req, Rep]
Terminates a filter chain in a Service.
- def andThen[Req2, Rep2](next: Filter[Req, Rep, Req2, Rep2]): Filter[Req, Rep, Req2, Rep2]
Chains a series of filters together:
Chains a series of filters together:
myModularService = handleExceptions.andThen(thrift2Pojo.andThen(parseString))
- next
another filter to follow after this one
- Definition Classes
- Filter
- Note
synchronously thrown exceptions in the underlying service are automatically lifted into Future.exception.
- def andThenIf[Req2 >: Req, Rep2 <: Rep](condAndFilter: (Boolean, Filter[Req, Rep, Req2, Rep2])): Filter[Req, Rep, Req2, Rep2]
Conditionally propagates requests down the filter chain.
Conditionally propagates requests down the filter chain. This may be useful if you are statically wiring together filter chains based on a configuration file, for instance.
- condAndFilter
a tuple of boolean and filter.
- Definition Classes
- Filter
- def andThenIf[Req2 >: Req, Rep2 <: Rep](conditional: Boolean, filter: Filter[Req, Rep, Req2, Rep2]): Filter[Req, Rep, Req2, Rep2]
Conditionally propagates requests down the filter chain.
Conditionally propagates requests down the filter chain. This may be useful if you are statically wiring together filter chains based on a configuration file, for instance.
- conditional
a boolean value indicating whether the filter should be included in the filter chain.
- filter
the filter to be conditionally included.
- Definition Classes
- Filter
- def apply(request: Req, service: Service[Req, Rep]): Future[Rep]
This is the method to override/implement to create your own Filter.
This is the method to override/implement to create your own Filter.
- request
the input request type
- service
a service that takes the output request type and the input response type
- Definition Classes
- DeadlineFilter → Filter → Function2
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def curried: (Req) => (Service[Req, Rep]) => Future[Rep]
- Definition Classes
- Function2
- Annotations
- @unspecialized()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- Filter → Function2 → AnyRef → Any
- def tupled: ((Req, Service[Req, Rep])) => Future[Rep]
- Definition Classes
- Function2
- Annotations
- @unspecialized()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()