object Throttle
Transform a service to reject any calls the go over a given rate.
- Source
- Throttle.scala
- Alphabetic
- By Inheritance
- Throttle
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- sealed abstract class TokenAvailability extends Product with Serializable
- trait TokenBucket[F[_]] extends AnyRef
A token bucket for use with the Throttle middleware.
A token bucket for use with the Throttle middleware. Consumers can take tokens which will be refilled over time. Implementations are required to provide their own refill mechanism.
Possible implementations include a remote TokenBucket service to coordinate between different application instances.
- final case class TokenUnavailable(retryAfter: Option[FiniteDuration]) extends TokenAvailability with Product with Serializable
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 apply[F[_], G[_]](bucket: TokenBucket[F], throttleResponse: (Option[FiniteDuration]) => Response[G] = defaultResponse[G])(http: Http[F, G])(implicit F: Monad[F]): Http[F, G]
Limits the supplied service using a provided TokenBucket
Limits the supplied service using a provided TokenBucket
- bucket
a TokenBucket to use to track the rate of incoming requests.
- throttleResponse
a function that defines the response when throttled, may be supplied a suggested retry time depending on bucket implementation.
- http
the service to transform.
- returns
a task containing the transformed service.
- def apply[F[_], G[_]](amount: Int, per: FiniteDuration)(http: Http[F, G])(implicit arg0: Temporal[F]): F[Http[F, G]]
Limits the supplied service to a given rate of calls using an in-memory TokenBucket
Limits the supplied service to a given rate of calls using an in-memory TokenBucket
- amount
the number of calls to the service to permit within the given time period.
- per
the time period over which a given number of calls is permitted.
- http
the service to transform.
- returns
a task containing the transformed service.
- 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 defaultResponse[F[_]](retryAfter: Option[FiniteDuration]): Response[F]
- 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()
- def httpApp[F[_]](bucket: TokenBucket[F], throttleResponse: (Option[FiniteDuration]) => Response[F] = defaultResponse[F])(httpApp: HttpApp[F])(implicit arg0: Monad[F]): HttpApp[F]
As apply(bucket,throttleResponse), but for HttpApp[F]
- def httpApp[F[_]](amount: Int, per: FiniteDuration)(httpApp: HttpApp[F])(implicit arg0: Temporal[F]): F[HttpApp[F]]
As apply(amount,per), but for HttpApp[F]
- def httpRoutes[F[_]](bucket: TokenBucket[F], throttleResponse: (Option[FiniteDuration]) => Response[F] = defaultResponse[F])(httpRoutes: HttpRoutes[F])(implicit arg0: Monad[F]): HttpRoutes[F]
As apply(bucket,throttleResponse), but for HttpRoutes[F]
- def httpRoutes[F[_]](amount: Int, per: FiniteDuration)(httpRoutes: HttpRoutes[F])(implicit arg0: Temporal[F]): F[HttpRoutes[F]]
As apply(amount,per), but for HttpRoutes[F]
- 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
- AnyRef → Any
- 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()
- case object TokenAvailable extends TokenAvailability with Product with Serializable
- object TokenBucket
Deprecated Value Members
- def httpAapp[F[_]](amount: Int, per: FiniteDuration)(httpApp: HttpApp[F])(implicit F: Temporal[F]): F[HttpApp[F]]
- Annotations
- @deprecated
- Deprecated
(Since version 0.23.14) Use httpApp instead.