Packages

final class AkkaForkJoinPool extends ForkJoinPool with LoadMetrics

INTERNAL AKKA USAGE ONLY

Source
ForkJoinExecutorConfigurator.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AkkaForkJoinPool
  2. LoadMetrics
  3. ForkJoinPool
  4. AbstractExecutorService
  5. ExecutorService
  6. Executor
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AkkaForkJoinPool(parallelism: Int, threadFactory: ForkJoinWorkerThreadFactory, unhandledExceptionHandler: UncaughtExceptionHandler)
  2. new AkkaForkJoinPool(parallelism: Int, threadFactory: ForkJoinWorkerThreadFactory, unhandledExceptionHandler: UncaughtExceptionHandler, asyncMode: Boolean)

Value Members

  1. def atFullThrottle(): Boolean
    Definition Classes
    AkkaForkJoinPool → LoadMetrics
  2. def awaitQuiescence(timeout: Long, unit: TimeUnit): Boolean

    If called by a ForkJoinTask operating in this pool, equivalent in effect to ForkJoinTask#helpQuiesce.

    If called by a ForkJoinTask operating in this pool, equivalent in effect to ForkJoinTask#helpQuiesce. Otherwise, waits and/or attempts to assist performing tasks until this pool #isQuiescent or the indicated timeout elapses.

    timeout

    the maximum time to wait

    unit

    the time unit of the timeout argument

    returns

    true if quiescent; false if the timeout elapsed.

    Definition Classes
    ForkJoinPool
  3. def awaitTermination(timeout: Long, unit: TimeUnit): Boolean

    Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

    Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first. Because the #commonPool() never terminates until program shutdown, when applied to the common pool, this method is equivalent to #awaitQuiescence but always returns false.

    timeout

    the maximum time to wait

    unit

    the time unit of the timeout argument

    returns

    true if this executor terminated and false if the timeout elapsed before termination

    Definition Classes
    ForkJoinPool → ExecutorService
    Exceptions thrown

    InterruptedException if interrupted while waiting

  4. def execute(r: Runnable): Unit

    Definition Classes
    AkkaForkJoinPoolForkJoinPool → Executor
    Exceptions thrown

    NullPointerException if the task is null

    RejectedExecutionException if the task cannot be scheduled for execution

  5. def execute(task: ForkJoinTask[_]): Unit

    Arranges for (asynchronous) execution of the given task.

    Arranges for (asynchronous) execution of the given task.

    task

    the task

    Definition Classes
    ForkJoinPool
    Exceptions thrown

    NullPointerException if the task is null

    RejectedExecutionException if the task cannot be scheduled for execution

  6. def getActiveThreadCount(): Int

    Returns an estimate of the number of threads that are currently stealing or executing tasks.

    Returns an estimate of the number of threads that are currently stealing or executing tasks. This method may overestimate the number of active threads.

    returns

    the number of active threads

    Definition Classes
    ForkJoinPool
  7. def getAsyncMode(): Boolean

    Returns true if this pool uses local first-in-first-out scheduling mode for forked tasks that are never joined.

    Returns true if this pool uses local first-in-first-out scheduling mode for forked tasks that are never joined.

    returns

    true if this pool uses async mode

    Definition Classes
    ForkJoinPool
  8. def getFactory(): ForkJoinWorkerThreadFactory

    Returns the factory used for constructing new workers.

    Returns the factory used for constructing new workers.

    returns

    the factory used for constructing new workers

    Definition Classes
    ForkJoinPool
  9. def getParallelism(): Int

    Returns the targeted parallelism level of this pool.

    Returns the targeted parallelism level of this pool.

    returns

    the targeted parallelism level of this pool

    Definition Classes
    ForkJoinPool
  10. def getPoolSize(): Int

    Returns the number of worker threads that have started but not yet terminated.

    Returns the number of worker threads that have started but not yet terminated. The result returned by this method may differ from #getParallelism when threads are created to maintain parallelism when others are cooperatively blocked.

    returns

    the number of worker threads

    Definition Classes
    ForkJoinPool
  11. def getQueuedSubmissionCount(): Int

    Returns an estimate of the number of tasks submitted to this pool that have not yet begun executing.

    Returns an estimate of the number of tasks submitted to this pool that have not yet begun executing. This method may take time proportional to the number of submissions.

    returns

    the number of queued submissions

    Definition Classes
    ForkJoinPool
  12. def getQueuedTaskCount(): Long

    Returns an estimate of the total number of tasks currently held in queues by worker threads (but not including tasks submitted to the pool that have not begun executing).

    Returns an estimate of the total number of tasks currently held in queues by worker threads (but not including tasks submitted to the pool that have not begun executing). This value is only an approximation, obtained by iterating across all threads in the pool. This method may be useful for tuning task granularities.

    returns

    the number of queued tasks

    Definition Classes
    ForkJoinPool
  13. def getRunningThreadCount(): Int

    Returns an estimate of the number of worker threads that are not blocked waiting to join tasks or for other managed synchronization.

    Returns an estimate of the number of worker threads that are not blocked waiting to join tasks or for other managed synchronization. This method may overestimate the number of running threads.

    returns

    the number of worker threads

    Definition Classes
    ForkJoinPool
  14. def getStealCount(): Long

    Returns an estimate of the total number of tasks stolen from one thread's work queue by another.

    Returns an estimate of the total number of tasks stolen from one thread's work queue by another. The reported value underestimates the actual total number of steals when the pool is not quiescent. This value may be useful for monitoring and tuning fork/join programs: in general, steal counts should be high enough to keep threads busy, but low enough to avoid overhead and contention across threads.

    returns

    the number of steals

    Definition Classes
    ForkJoinPool
  15. def getUncaughtExceptionHandler(): UncaughtExceptionHandler

    Returns the handler for internal worker threads that terminate due to unrecoverable errors encountered while executing tasks.

    Returns the handler for internal worker threads that terminate due to unrecoverable errors encountered while executing tasks.

    returns

    the handler, or null if none

    Definition Classes
    ForkJoinPool
  16. def hasQueuedSubmissions(): Boolean

    Returns true if there are any tasks submitted to this pool that have not yet begun executing.

    Returns true if there are any tasks submitted to this pool that have not yet begun executing.

    returns

    true if there are any queued submissions

    Definition Classes
    ForkJoinPool
  17. def invoke[T](task: ForkJoinTask[T]): T

    Performs the given task, returning its result upon completion.

    Performs the given task, returning its result upon completion. If the computation encounters an unchecked Exception or Error, it is rethrown as the outcome of this invocation. Rethrown exceptions behave in the same way as regular exceptions, but, when possible, contain stack traces (as displayed for example using ex.printStackTrace()) of both the current thread as well as the thread actually encountering the exception; minimally only the latter.

    task

    the task

    returns

    the task's result

    Definition Classes
    ForkJoinPool
    Exceptions thrown

    NullPointerException if the task is null

    RejectedExecutionException if the task cannot be scheduled for execution

  18. def invokeAll[T](tasks: Collection[_ <: Callable[T]]): List[Future[T]]

    Definition Classes
    ForkJoinPool → AbstractExecutorService → ExecutorService
    Exceptions thrown

    NullPointerException <invalid inheritdoc annotation>

    RejectedExecutionException <invalid inheritdoc annotation>

  19. def invokeAll[T](arg0: Collection[_ <: Callable[T]], arg1: Long, arg2: TimeUnit): List[Future[T]]
    Definition Classes
    AbstractExecutorService → ExecutorService
    Annotations
    @throws( ... )
  20. def invokeAny[T](arg0: Collection[_ <: Callable[T]], arg1: Long, arg2: TimeUnit): T
    Definition Classes
    AbstractExecutorService → ExecutorService
    Annotations
    @throws( ... ) @throws( ... ) @throws( ... )
  21. def invokeAny[T](arg0: Collection[_ <: Callable[T]]): T
    Definition Classes
    AbstractExecutorService → ExecutorService
    Annotations
    @throws( ... ) @throws( ... )
  22. def isQuiescent(): Boolean

    Returns true if all worker threads are currently idle.

    Returns true if all worker threads are currently idle. An idle worker is one that cannot obtain a task to execute because none are available to steal from other threads, and there are no pending submissions to the pool. This method is conservative; it might not return true immediately upon idleness of all threads, but will eventually become true if threads remain inactive.

    returns

    true if all threads are currently idle

    Definition Classes
    ForkJoinPool
  23. def isShutdown(): Boolean

    Returns true if this pool has been shut down.

    Returns true if this pool has been shut down.

    returns

    true if this pool has been shut down

    Definition Classes
    ForkJoinPool → ExecutorService
  24. def isTerminated(): Boolean

    Returns true if all tasks have completed following shut down.

    Returns true if all tasks have completed following shut down.

    returns

    true if all tasks have completed following shut down

    Definition Classes
    ForkJoinPool → ExecutorService
  25. def isTerminating(): Boolean

    Returns true if the process of termination has commenced but not yet completed.

    Returns true if the process of termination has commenced but not yet completed. This method may be useful for debugging. A return of true reported a sufficient period after shutdown may indicate that submitted tasks have ignored or suppressed interruption, or are waiting for I/O, causing this executor not to properly terminate. (See the advisory notes for class ForkJoinTask stating that tasks should not normally entail blocking operations. But if they do, they must abort them on interrupt.)

    returns

    true if terminating but not yet terminated

    Definition Classes
    ForkJoinPool
  26. def shutdown(): Unit

    Possibly initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.

    Possibly initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no effect on execution state if this is the #commonPool(), and no additional effect if already shut down. Tasks that are in the process of being submitted concurrently during the course of this method may or may not be rejected.

    Definition Classes
    ForkJoinPool → ExecutorService
    Exceptions thrown

    SecurityException if a security manager exists and the caller is not permitted to modify threads because it does not hold java.lang.RuntimePermission("modifyThread")

  27. def shutdownNow(): List[Runnable]

    Possibly attempts to cancel and/or stop all tasks, and reject all subsequently submitted tasks.

    Possibly attempts to cancel and/or stop all tasks, and reject all subsequently submitted tasks. Invocation has no effect on execution state if this is the #commonPool(), and no additional effect if already shut down. Otherwise, tasks that are in the process of being submitted or executed concurrently during the course of this method may or may not be rejected. This method cancels both existing and unexecuted tasks, in order to permit termination in the presence of task dependencies. So the method always returns an empty list (unlike the case for some other Executors).

    returns

    an empty list

    Definition Classes
    ForkJoinPool → ExecutorService
    Exceptions thrown

    SecurityException if a security manager exists and the caller is not permitted to modify threads because it does not hold java.lang.RuntimePermission("modifyThread")

  28. def submit(task: Runnable): ForkJoinTask[_]

    Definition Classes
    ForkJoinPool → AbstractExecutorService → ExecutorService
    Exceptions thrown

    NullPointerException if the task is null

    RejectedExecutionException if the task cannot be scheduled for execution

  29. def submit[T](task: Runnable, result: T): ForkJoinTask[T]

    Definition Classes
    ForkJoinPool → AbstractExecutorService → ExecutorService
    Exceptions thrown

    NullPointerException if the task is null

    RejectedExecutionException if the task cannot be scheduled for execution

  30. def submit[T](task: Callable[T]): ForkJoinTask[T]

    Definition Classes
    ForkJoinPool → AbstractExecutorService → ExecutorService
    Exceptions thrown

    NullPointerException if the task is null

    RejectedExecutionException if the task cannot be scheduled for execution

  31. def submit[T](task: ForkJoinTask[T]): ForkJoinTask[T]

    Submits a ForkJoinTask for execution.

    Submits a ForkJoinTask for execution.

    task

    the task to submit

    returns

    the task

    Definition Classes
    ForkJoinPool
    Exceptions thrown

    NullPointerException if the task is null

    RejectedExecutionException if the task cannot be scheduled for execution

  32. def toString(): String

    Returns a string identifying this pool, as well as its state, including indications of run state, parallelism level, and worker and task counts.

    Returns a string identifying this pool, as well as its state, including indications of run state, parallelism level, and worker and task counts.

    returns

    a string identifying this pool, as well as its state

    Definition Classes
    ForkJoinPool → AnyRef → Any