class LoopingTaskRunner extends AnyRef
Represents a queue of tasks that will be executed infinitely in order until removed.
- Alphabetic
- By Inheritance
- LoopingTaskRunner
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
LoopingTaskRunner(initialWorkers: Int = DefaultInitialWorkers, maxTaskWaitTime: (Long, TimeUnit) = DefaultMaxTaskWaitTime)
- initialWorkers
The total number of works to use for this runner on startup (more can be added or removed)
- maxTaskWaitTime
The maximum time to wait for a task to be pulled off of the queue before allowing other tasks to be run
Type Members
- type TaskId = String
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
-
def
addTask[T](task: ⇒ T): TaskId
Adds a task to be executed repeatedly (in a queue with other tasks).
Adds a task to be executed repeatedly (in a queue with other tasks).
- T
The return type of the task
- task
The task to add
- returns
The id of the queued task
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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
getCurrentActiveWorkers: Int
Retrieves the total actively-running workers.
Retrieves the total actively-running workers.
- returns
The total active workers at this point in time
-
def
getDesiredTotalWorkers: Int
Retrieves the current desired total number of workers.
Retrieves the current desired total number of workers.
- returns
The desired total number of workers
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isRunning: Boolean
Indicates whether or not the task runner is processing tasks.
Indicates whether or not the task runner is processing tasks.
- returns
True if it is running, otherwise false
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
newExecutorService(): ExecutorService
Creates a new executor service for use by the looping task runner.
Creates a new executor service for use by the looping task runner.
- returns
The new executor service instance
- Attributes
- protected
-
def
newLoopingTask(): Runnable
Creates a new looping task to be executed.
Creates a new looping task to be executed.
- Attributes
- protected
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
removeTask(taskId: TaskId): Runnable
Removes a task from the repeated execution.
Removes a task from the repeated execution.
- taskId
The id of the task to remove
- returns
Task implementation that was removed
-
def
runNextTask(): Unit
Executes next available task.
Executes next available task.
- Attributes
- protected
-
def
setDesiredTotalWorkers(value: Int): Unit
Sets the desired total number of workers to eventually be achieved by the task runner.
Sets the desired total number of workers to eventually be achieved by the task runner.
- value
The new desired total number of workers
-
def
start(): Unit
Executing begins the process of executing queued up tasks.
-
def
stop(removeAllTasks: Boolean = true): Unit
Prevents the runner from executing any more tasks.
Prevents the runner from executing any more tasks.
- removeAllTasks
If true, removes all tasks after being stopped
-
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( ... )