Trait

s_mach.concurrent.config

AbstractAsyncConfigBuilder

Related Doc: package config

Permalink

trait AbstractAsyncConfigBuilder[MDT <: AbstractAsyncConfigBuilder[MDT]] extends OptProgressConfigBuilder[MDT] with OptRetryConfigBuilder[MDT] with OptThrottleConfigBuilder[MDT] with AsyncConfig

A base trait for an immutable AsyncConfig builder that allows configuring optional progress reporting, failure retry and throttling.

MDT

most derived type

Linear Supertypes
AsyncConfig, OptThrottleConfig, OptRetryConfig, OptProgressConfig, OptThrottleConfigBuilder[MDT], OptRetryConfigBuilder[MDT], OptProgressConfigBuilder[MDT], AnyRef, Any
Known Subclasses
AbstractCollectionAsyncTaskRunner, AsyncConfigBuilder, CollectionAsyncTaskRunner, ParCollectionAsyncTaskRunner
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractAsyncConfigBuilder
  2. AsyncConfig
  3. OptThrottleConfig
  4. OptRetryConfig
  5. OptProgressConfig
  6. OptThrottleConfigBuilder
  7. OptRetryConfigBuilder
  8. OptProgressConfigBuilder
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def optProgress: Option[ProgressConfig]

    Permalink
    Definition Classes
    OptProgressConfig

  2. abstract def optRetry: Option[RetryConfig]

    Permalink
    Definition Classes
    OptRetryConfig

  3. abstract def optThrottle: Option[ThrottleConfig]

    Permalink
    Definition Classes
    OptThrottleConfig

  4. abstract def optTotal: Option[Int]

    Permalink
    Definition Classes
    OptProgressConfig

  5. abstract def using(optProgress: Option[ProgressConfig] = optProgress, optRetry: Option[RetryConfig] = optRetry, optThrottle: Option[ThrottleConfig] = optThrottle): MDT

    Permalink

  6. abstract def workerCount: Int

    Permalink
    Definition Classes
    AsyncConfig

Concrete 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
    AbstractAsyncConfigBuilder → OptThrottleConfigBuilder → OptRetryConfigBuilder → OptProgressConfigBuilder

  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 equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Permalink
    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. def progress(r: TaskEventListener)(implicit ec: ExecutionContext): MDT

    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
    AbstractAsyncConfigBuilder → OptProgressConfigBuilder

  17. def progress(reportInterval: FiniteDuration)(report: (Progress) ⇒ Unit)(implicit executionContext: ExecutionContext, scheduledExecutionContext: ScheduledExecutionContext): MDT

    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

  18. def progress(report: (Progress) ⇒ Unit)(implicit ec: ExecutionContext): MDT

    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

  19. def retry(f: (List[Throwable]) ⇒ Future[Boolean])(implicit ec: ExecutionContext): MDT

    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

  20. def retryDecider(r: RetryDecider)(implicit ec: ExecutionContext): MDT

    Permalink

    Set the optional retry function

    Set the optional retry function

    returns

    a copy of the builder with the new setting

    Definition Classes
    AbstractAsyncConfigBuilder → OptRetryConfigBuilder

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

    Permalink
    Definition Classes
    AnyRef

  22. def throttle(_throttle: Duration)(implicit scheduledExecutionContext: ScheduledExecutionContext): MDT

    Permalink

    Set the optional throttle period

    Set the optional throttle period

    _throttle

    the throttle period

    Definition Classes
    OptThrottleConfigBuilder

  23. def throttle_ns(_throttle_ns: Long)(implicit sec: ScheduledExecutionContext): MDT

    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
    AbstractAsyncConfigBuilder → OptThrottleConfigBuilder

  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  25. def using(cfg: AsyncConfig): MDT

    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

  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AsyncConfig

Inherited from OptThrottleConfig

Inherited from OptRetryConfig

Inherited from OptProgressConfig

Inherited from OptThrottleConfigBuilder[MDT]

Inherited from OptRetryConfigBuilder[MDT]

Inherited from OptProgressConfigBuilder[MDT]

Inherited from AnyRef

Inherited from Any

Ungrouped