trait RateLimiter[F[_]] extends AnyRef
- F
- effect type
- Alphabetic
- By Inheritance
- RateLimiter
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def acquire[A](key: A, instant: Instant, cost: Long)(implicit arg0: Key[A]): F[Boolean]
Try to acquire token.
Try to acquire token. Returns immediately.
- A
- key type with implicit genkai.Key type class instance
- key
- ~ object id
- instant
- request time
- cost
- request cost
- returns
- true if token was acquired, false - otherwise
- abstract def close(): F[Unit]
Close underlying resources if any
Close underlying resources if any
- returns
- unit if successfully closed or error wrapped in effect
- abstract def monadError: MonadError[F]
- Attributes
- protected
- abstract def permissions[A](key: A)(implicit arg0: Key[A]): F[Long]
- A
- key type with implicit genkai.Key type class instance
- key
- ~ object id
- returns
- unused permissions
- abstract def reset[A](key: A)(implicit arg0: Key[A]): F[Unit]
- A
- key type with implicit genkai.Key type class instance
- key
- ~ object id
- returns
- unit if successfully reset tokens
Concrete 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
- final def acquire[A](key: A, cost: Long)(implicit arg0: Key[A]): F[Boolean]
Try to acquire token.
Try to acquire token. Returns immediately.
- A
- key type with implicit genkai.Key type class instance
- key
- ~ object id
- cost
- request cost
- final def acquire[A](key: A, instant: Instant)(implicit arg0: Key[A]): F[Boolean]
Try to acquire token.
Try to acquire token. Returns immediately.
- A
- key type with implicit genkai.Key type class instance
- key
- ~ object id
- instant
- request time
- final def acquire[A](key: A)(implicit arg0: Key[A]): F[Boolean]
Try to acquire token.
Try to acquire token. Returns immediately.
- A
- key type with implicit genkai.Key type class instance
- key
- ~ object id
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- 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()