QueueObject

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 buffer: Int

   

   A minimum threshold buffer in order to say that the queue is unsaturated.

6. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

7. var concurrency: Int

   

   an integer for determining how many worker functions should be run in parallel.

   an integer for determining how many worker functions should be run in parallel. This property can be changed after a queue is created to alter the concurrency on-the-fly.

8. var drain: Function

   

   A callback that is called when the last item from the queue has returned from the worker.

9. var empty: Function

   

   A callback that is called when the last item from the queue is given to a worker.

10. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

11. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

12. var error: Function

    

    A callback that is called when a task errors.

    A callback that is called when a task errors. Has the signature function(error, task).

13. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

14. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

15. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

16. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

17. def idle(): Boolean

    
    returns

    false if there are items waiting or being processed, or true if not.

    Example:

    1. queue.idle()

18. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

19. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

20. def kill(): Unit

    

    A function that removes the drain callback and empties remaining tasks from the queue forcing it to go idle.

    A function that removes the drain callback and empties remaining tasks from the queue forcing it to go idle.

    Example:

    1. queue.kill()

21. def length(): Int

    
    returns

    the number of items waiting to be processed.

    Example:

    1. queue.length()

22. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

23. final def notify(): Unit

    

    Definition Classes

    AnyRef

24. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

25. def pause(): Unit

    

    A function that pauses the processing of tasks until resume() is called.

    A function that pauses the processing of tasks until resume() is called.

    Example:

    1. queue.pause()

26. def paused: Boolean

    

    A boolean for determining whether the queue is in a paused state.

27. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

28. def push(task: |[T, Array[T]], callback: Function = null): Unit

    

    add a new task to the queue.

    add a new task to the queue. Calls callback once the worker has finished processing the task. Instead of a single task, a tasks array can be submitted. The respective callback is used for every task in the list.

    Example:

    1. queue.push(task, [callback])

29. def resume(): Unit

    

    A function that resumes the processing of queued tasks when the queue is paused.

    A function that resumes the processing of queued tasks when the queue is paused.

    Example:

    1. queue.resume()

30. def running(): Boolean

    
    returns

    the number of items currently being processed.

    Example:

    1. queue.running()

31. var saturated: Function

    

    A callback that is called when the number of running workers hits the concurrency limit, and further tasks will be queued.

32. def started: Boolean

    

    A boolean indicating whether or not any items have been pushed and processed by the queue.

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

    

    Definition Classes

    AnyRef

34. def toLocaleString(): String

    

    Definition Classes

    Object

35. def toString(): String

    

    Definition Classes

    AnyRef → Any

36. var unsaturated: Function

    

    A callback that is called when the number of running workers is less than the concurrency & buffer limits, and further tasks will not be queued.

37. def unshift(task: T, callback: Function = null): Unit

    

    Add a new task to the front of the queue.sbt pu

    Add a new task to the front of the queue.sbt pu

    Example:

    1. queue.unshift(task, [callback])

38. def valueOf(): Any

    

    Definition Classes

    Object

39. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

41. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

42. def workersList(): Array[T]

    
    returns

    the array of items currently being processed.

    Example:

    1. queue.workersList()