Class

com.kemichal.functionqueue

AsyncUniqueFunctionQueue

Related Doc: package functionqueue

Permalink

class AsyncUniqueFunctionQueue[A] extends AnyRef

The AsyncUniqueFunctionQueue allows you to queue up a series of functions to run. The functions is run one at a time (sequentially) and will not block the current thread (asynchronously). Every function has an associated key which must be unique for the queue, or else the function can't be added.

This is useful behavior when you expect several equivalent calls in a short time, and only want to process the first one.

A

type of the key to be used to check for equality

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

Instance Constructors

  1. new AsyncUniqueFunctionQueue(swallowExceptions: Boolean = false)(implicit ec: ExecutionContext)

    Permalink

    swallowExceptions

    if exceptions thrown in functions should be rethrown

    ec

    the execution context on which the function is run

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def add(key: A)(f: ⇒ Unit): Option[String]

    Permalink

    Queues a function to be run sometime in the future, assuming that the key is unique for the queue.

    Queues a function to be run sometime in the future, assuming that the key is unique for the queue.

    key

    the key used to determine if the function is to be added

    f

    the function to run

    returns

    None if the function was queued successfully, otherwise Some error message

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

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

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

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped