Packages

final class AkkaForkJoinPool extends ForkJoinPool with LoadMetrics

INTERNAL AKKA USAGE ONLY

Source
ForkJoinExecutorConfigurator.scala
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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from AkkaForkJoinPool to any2stringadd[AkkaForkJoinPool] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AkkaForkJoinPool, B)
    Implicit
    This member is added by an implicit conversion from AkkaForkJoinPool to ArrowAssoc[AkkaForkJoinPool] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def atFullThrottle(): Boolean
    Definition Classes
    AkkaForkJoinPool → LoadMetrics
  8. 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
  9. 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

  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  11. def drainTasksTo(c: Collection[_ >: ForkJoinTask[_]]): Int

    Removes all available unexecuted submitted and forked tasks from scheduling queues and adds them to the given collection, without altering their execution status.

    Removes all available unexecuted submitted and forked tasks from scheduling queues and adds them to the given collection, without altering their execution status. These may include artificially generated or wrapped tasks. This method is designed to be invoked only when the pool is known to be quiescent. Invocations at other times may not remove all tasks. A failure encountered while attempting to add elements to collection c may result in elements being in neither, either or both collections when the associated exception is thrown. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

    c

    the collection to transfer elements into

    returns

    the number of elements transferred

    Attributes
    protected[akka.dispatch.forkjoin]
    Definition Classes
    ForkJoinPool
  12. def ensuring(cond: (AkkaForkJoinPool) ⇒ Boolean, msg: ⇒ Any): AkkaForkJoinPool
    Implicit
    This member is added by an implicit conversion from AkkaForkJoinPool to Ensuring[AkkaForkJoinPool] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (AkkaForkJoinPool) ⇒ Boolean): AkkaForkJoinPool
    Implicit
    This member is added by an implicit conversion from AkkaForkJoinPool to Ensuring[AkkaForkJoinPool] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): AkkaForkJoinPool
    Implicit
    This member is added by an implicit conversion from AkkaForkJoinPool to Ensuring[AkkaForkJoinPool] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): AkkaForkJoinPool
    Implicit
    This member is added by an implicit conversion from AkkaForkJoinPool to Ensuring[AkkaForkJoinPool] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. 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

  19. 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

  20. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AkkaForkJoinPool to StringFormat[AkkaForkJoinPool] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  21. 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
  22. 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
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. 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
  25. 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
  26. 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
  27. 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
  28. 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
  29. 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
  30. 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
  31. 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
  32. 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
  33. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. 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

  35. 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>

  36. def invokeAll[T](arg0: Collection[_ <: Callable[T]], arg1: Long, arg2: TimeUnit): List[Future[T]]
    Definition Classes
    AbstractExecutorService → ExecutorService
    Annotations
    @throws( ... )
  37. def invokeAny[T](arg0: Collection[_ <: Callable[T]], arg1: Long, arg2: TimeUnit): T
    Definition Classes
    AbstractExecutorService → ExecutorService
    Annotations
    @throws( ... ) @throws( ... ) @throws( ... )
  38. def invokeAny[T](arg0: Collection[_ <: Callable[T]]): T
    Definition Classes
    AbstractExecutorService → ExecutorService
    Annotations
    @throws( ... ) @throws( ... )
  39. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  40. 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
  41. 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
  42. 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
  43. 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
  44. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. def newTaskFor[T](callable: Callable[T]): RunnableFuture[T]
    Attributes
    protected[akka.dispatch.forkjoin]
    Definition Classes
    ForkJoinPool → AbstractExecutorService
  46. def newTaskFor[T](runnable: Runnable, value: T): RunnableFuture[T]
    Attributes
    protected[akka.dispatch.forkjoin]
    Definition Classes
    ForkJoinPool → AbstractExecutorService
  47. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  48. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  49. def pollSubmission(): ForkJoinTask[_]

    Removes and returns the next unexecuted submission if one is available.

    Removes and returns the next unexecuted submission if one is available. This method may be useful in extensions to this class that re-assign work in systems with multiple pools.

    returns

    the next submission, or null if none

    Attributes
    protected[akka.dispatch.forkjoin]
    Definition Classes
    ForkJoinPool
  50. 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")

  51. 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")

  52. 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

  53. 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

  54. 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

  55. 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

  56. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  57. 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
  58. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  60. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. def [B](y: B): (AkkaForkJoinPool, B)
    Implicit
    This member is added by an implicit conversion from AkkaForkJoinPool to ArrowAssoc[AkkaForkJoinPool] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from LoadMetrics

Inherited from ForkJoinPool

Inherited from AbstractExecutorService

Inherited from ExecutorService

Inherited from Executor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from AkkaForkJoinPool to any2stringadd[AkkaForkJoinPool]

Inherited by implicit conversion StringFormat from AkkaForkJoinPool to StringFormat[AkkaForkJoinPool]

Inherited by implicit conversion Ensuring from AkkaForkJoinPool to Ensuring[AkkaForkJoinPool]

Inherited by implicit conversion ArrowAssoc from AkkaForkJoinPool to ArrowAssoc[AkkaForkJoinPool]

Ungrouped