Class

s_mach.concurrent.impl

CollectionAsyncTaskRunner

Related Doc: package impl

Permalink

case class CollectionAsyncTaskRunner[A, M[+AA] <: TraversableOnce[AA]](input: M[A], optProgress: Option[ProgressConfig] = None, optRetry: Option[RetryConfig] = None, optThrottle: Option[ThrottleConfig] = None) extends AbstractCollectionAsyncTaskRunner[A, M, CollectionAsyncTaskRunner[A, M]] with Product with Serializable

A case class for a serial asynchronous task runner that is configurable with optional progress reporting, throttling and/or failure retry.

A

the input type

M

the collection type

input

the input collection

optProgress

optional progress reporting settings

optRetry

optional failure retry settings

optThrottle

optional throttle settings

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CollectionAsyncTaskRunner
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AbstractCollectionAsyncTaskRunner
  7. AbstractAsyncConfigBuilder
  8. AsyncConfig
  9. OptThrottleConfig
  10. OptRetryConfig
  11. OptProgressConfig
  12. OptThrottleConfigBuilder
  13. OptRetryConfigBuilder
  14. OptProgressConfigBuilder
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CollectionAsyncTaskRunner(input: M[A], optProgress: Option[ProgressConfig] = None, optRetry: Option[RetryConfig] = None, optThrottle: Option[ThrottleConfig] = None)

    Permalink

    input

    the input collection

    optProgress

    optional progress reporting settings

    optRetry

    optional failure retry settings

    optThrottle

    optional throttle settings

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def build(): AsyncConfig

    Permalink

    returns

    a config instance with the current settings

    Definition Classes
    AbstractAsyncConfigBuilderOptThrottleConfigBuilderOptRetryConfigBuilderOptProgressConfigBuilder
  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 finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def flatMap[B](f: (A) ⇒ Future[TraversableOnce[B]])(implicit cbf: CanBuildFrom[Nothing, B, M[B]], ec: ExecutionContext): Future[M[B]]

    Permalink
    Annotations
    @inline()
  10. def foldLeft[B](z: B)(f: (B, A) ⇒ Future[B])(implicit cbf: CanBuildFrom[Nothing, B, M[B]], ec: ExecutionContext): Future[B]

    Permalink
    Annotations
    @inline()
  11. def foreach[U](f: (A) ⇒ Future[U])(implicit ec: ExecutionContext): Future[Unit]

    Permalink
    Annotations
    @inline()
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. val input: M[A]

    Permalink

    the input collection

    the input collection

    Definition Classes
    CollectionAsyncTaskRunnerAbstractCollectionAsyncTaskRunner
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. def map[B](f: (A) ⇒ Future[B])(implicit cbf: CanBuildFrom[Nothing, B, M[B]], ec: ExecutionContext): Future[M[B]]

    Permalink
    Annotations
    @inline()
  16. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  19. val optProgress: Option[ProgressConfig]

    Permalink

    optional progress reporting settings

    optional progress reporting settings

    Definition Classes
    CollectionAsyncTaskRunnerOptProgressConfig
  20. val optRetry: Option[RetryConfig]

    Permalink

    optional failure retry settings

    optional failure retry settings

    Definition Classes
    CollectionAsyncTaskRunnerOptRetryConfig
  21. val optThrottle: Option[ThrottleConfig]

    Permalink

    optional throttle settings

    optional throttle settings

    Definition Classes
    CollectionAsyncTaskRunnerOptThrottleConfig
  22. def optTotal: Option[Int]

    Permalink

    The optional total number of operations as set by derived type

    The optional total number of operations as set by derived type

    Definition Classes
    AbstractCollectionAsyncTaskRunnerOptProgressConfigOptProgressConfigBuilder
  23. def par(workerCount: Int): ParCollectionAsyncTaskRunner[A, M]

    Permalink

    returns

    a parallel async task runner configured to run with workerCount workers and with a copy of all settings

  24. def par: ParCollectionAsyncTaskRunner[A, M]

    Permalink

    returns

    a parallel async task runner configured with a copy of all settings

  25. def progress(r: TaskEventListener)(implicit ec: ExecutionContext): CollectionAsyncTaskRunner[A, M]

    Permalink

    Set the optional progress reporting function

    Set the optional progress reporting function

    returns

    a copy of the builder with the new setting

    Definition Classes
    AbstractAsyncConfigBuilderOptProgressConfigBuilder
  26. def progress(reportInterval: FiniteDuration)(report: (Progress) ⇒ Unit)(implicit executionContext: ExecutionContext, scheduledExecutionContext: ScheduledExecutionContext): CollectionAsyncTaskRunner[A, M]

    Permalink

    Set the progress reporting function to periodically report progress

    Set the progress reporting function to periodically report progress

    reportInterval

    the interval to report progress

    report

    a function that accepts the number of operations completed and the total number of operations (or 0 if the total is unknown)

    returns

    a copy of the builder with the new setting

    Definition Classes
    OptProgressConfigBuilder
  27. def progress(report: (Progress) ⇒ Unit)(implicit ec: ExecutionContext): CollectionAsyncTaskRunner[A, M]

    Permalink

    Set the progress reporting function

    Set the progress reporting function

    report

    a function that accepts the number of operations completed and the total number of operations (or 0 if the total is unknown)

    returns

    a copy of the builder with the new setting

    Definition Classes
    OptProgressConfigBuilder
  28. def retry(f: (List[Throwable]) ⇒ Future[Boolean])(implicit ec: ExecutionContext): CollectionAsyncTaskRunner[A, M]

    Permalink

    Set the optional retry function

    Set the optional retry function

    f

    a function that accepts a list of failures so far for an operation. The function returns TRUE if the operation should be retried.

    returns

    a copy of the builder with the new setting

    Definition Classes
    OptRetryConfigBuilder
  29. def retryDecider(r: RetryDecider)(implicit ec: ExecutionContext): CollectionAsyncTaskRunner[A, M]

    Permalink

    Set the optional retry function

    Set the optional retry function

    returns

    a copy of the builder with the new setting

    Definition Classes
    AbstractAsyncConfigBuilderOptRetryConfigBuilder
  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  31. def throttle(_throttle: Duration)(implicit scheduledExecutionContext: ScheduledExecutionContext): CollectionAsyncTaskRunner[A, M]

    Permalink

    Set the optional throttle period

    Set the optional throttle period

    _throttle

    the throttle period

    Definition Classes
    OptThrottleConfigBuilder
  32. def throttle_ns(_throttle_ns: Long)(implicit sec: ScheduledExecutionContext): CollectionAsyncTaskRunner[A, M]

    Permalink

    Set the optional throttle setting in nanoseconds

    Set the optional throttle setting in nanoseconds

    _throttle_ns

    the throttle period in nanoseconds

    returns

    a copy of the builder with the new setting

    Definition Classes
    AbstractAsyncConfigBuilderOptThrottleConfigBuilder
  33. def using(optProgress: Option[ProgressConfig] = optProgress, optRetry: Option[RetryConfig] = optRetry, optThrottle: Option[ThrottleConfig] = optThrottle): CollectionAsyncTaskRunner[A, M]

    Permalink
  34. def using(cfg: AsyncConfig): CollectionAsyncTaskRunner[A, M]

    Permalink

    Copy an existing configuration

    Copy an existing configuration

    cfg

    configuration to use

    returns

    a copy of the builder with all settings copied from cfg

    Definition Classes
    AbstractAsyncConfigBuilder
  35. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. val workerCount: Int

    Permalink
    Definition Classes
    CollectionAsyncTaskRunnerAsyncConfig

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AsyncConfig

Inherited from OptThrottleConfig

Inherited from OptRetryConfig

Inherited from OptProgressConfig

Inherited from AnyRef

Inherited from Any

Ungrouped