Packages

class Debouncer extends AnyRef

Highly performant generic debouncer

Note: This is not written as an Actor for performance reasons. Debounced calls are filtered synchronously, in the caller thread, without the need for locks, context switches, or heap allocations. We use AtomicBoolean to resolve concurrent races; the probability of contending on an AtomicBoolean transition is very low.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Debouncer
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Debouncer(name: String, scheduler: SchedulerLike, delay: FiniteDuration, maxDelay: FiniteDuration, action: () ⇒ Unit, debounceFirst: Boolean = true, clock: Clock = Clock.systemUTC)

    name

    The name of this debouncer

    scheduler

    The scheduler implementation to use; Can accept an akka scheduler a la magnet pattern

    delay

    The time after which to invoke action; each time Debouncer.call is invoked, this delay is reset

    maxDelay

    The maximum time to delay the invocation of action()

    action

    The action to invoke

    debounceFirst

    If false, then the first invocation of call() calls action exactly once. Subsequent calls are debounced.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def call(): Unit

    Register that the provided action should be called according to the debounce logic

  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped