Throttle

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
object TokenAvailable extends TokenAvailability with Product with Serializable
object TokenBucket
def apply[F[_], G[_]](bucket: TokenBucket[F], throttleResponse: (Option[FiniteDuration]) ⇒ Response[G] = defaultResponse[G])(http: Http[F, G])(implicit F: Sync[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 F: Sync[F], timer: Clock[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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def defaultResponse[F[_]](retryAfter: Option[FiniteDuration]): Response[F]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package middleware

object Throttle

Type Members

sealed abstract class TokenAvailability extends Product with Serializable

trait TokenBucket[F[_]] extends AnyRef

final case class TokenUnavailable(retryAfter: Option[FiniteDuration]) extends TokenAvailability with Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object TokenAvailable extends TokenAvailability with Product with Serializable

object TokenBucket

def apply[F[_], G[_]](bucket: TokenBucket[F], throttleResponse: (Option[FiniteDuration]) ⇒ Response[G] = defaultResponse[G])(http: Http[F, G])(implicit F: Sync[F]): Http[F, G]

def apply[F[_], G[_]](amount: Int, per: FiniteDuration)(http: Http[F, G])(implicit F: Sync[F], timer: Clock[F]): F[Http[F, G]]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def defaultResponse[F[_]](retryAfter: Option[FiniteDuration]): Response[F]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped