Class

s_mach.concurrent.config

AsyncConfigBuilder

Related Doc: package config

Permalink

case class AsyncConfigBuilder(workerCount: Int = 1, optProgress: Option[ProgressConfig] = None, optRetry: Option[RetryConfig] = None, optThrottle: Option[ThrottleConfig] = None) extends AbstractAsyncConfigBuilder[AsyncConfigBuilder] with Product with Serializable

A case class for an immutable AsyncConfig builder

workerCount

number of parallel workers to use during task

optProgress

optional progress reporting settings

optRetry

optional failure retry settings

optThrottle

optional throttle setting

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

Instance Constructors

  1. new AsyncConfigBuilder(workerCount: Int = 1, optProgress: Option[ProgressConfig] = None, optRetry: Option[RetryConfig] = None, optThrottle: Option[ThrottleConfig] = None)

    Permalink

    workerCount

    number of parallel workers to use during task

    optProgress

    optional progress reporting settings

    optRetry

    optional failure retry settings

    optThrottle

    optional throttle setting

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. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink

    optional progress reporting settings

    optional progress reporting settings

    Definition Classes
    AsyncConfigBuilderOptProgressConfig
  15. val optRetry: Option[RetryConfig]

    Permalink

    optional failure retry settings

    optional failure retry settings

    Definition Classes
    AsyncConfigBuilderOptRetryConfig
  16. val optThrottle: Option[ThrottleConfig]

    Permalink

    optional throttle setting

    optional throttle setting

    Definition Classes
    AsyncConfigBuilderOptThrottleConfig
  17. val optTotal: None.type

    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
    AsyncConfigBuilderOptProgressConfigOptProgressConfigBuilder
  18. def par(workerCount: Int): AsyncConfigBuilder

    Permalink
  19. def par: AsyncConfigBuilder

    Permalink
  20. def progress(r: TaskEventListener)(implicit ec: ExecutionContext): AsyncConfigBuilder

    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
  21. def progress(reportInterval: FiniteDuration)(report: (Progress) ⇒ Unit)(implicit executionContext: ExecutionContext, scheduledExecutionContext: ScheduledExecutionContext): AsyncConfigBuilder

    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
  22. def progress(report: (Progress) ⇒ Unit)(implicit ec: ExecutionContext): AsyncConfigBuilder

    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
  23. def retry(f: (List[Throwable]) ⇒ Future[Boolean])(implicit ec: ExecutionContext): AsyncConfigBuilder

    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
  24. def retryDecider(r: RetryDecider)(implicit ec: ExecutionContext): AsyncConfigBuilder

    Permalink

    Set the optional retry function

    Set the optional retry function

    returns

    a copy of the builder with the new setting

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

    Permalink
    Definition Classes
    AnyRef
  26. def throttle(_throttle: Duration)(implicit scheduledExecutionContext: ScheduledExecutionContext): AsyncConfigBuilder

    Permalink

    Set the optional throttle period

    Set the optional throttle period

    _throttle

    the throttle period

    Definition Classes
    OptThrottleConfigBuilder
  27. def throttle_ns(_throttle_ns: Long)(implicit sec: ScheduledExecutionContext): AsyncConfigBuilder

    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
  28. def using(optProgress: Option[ProgressConfig], optRetry: Option[RetryConfig], optThrottle: Option[ThrottleConfig]): AsyncConfigBuilder

    Permalink
  29. def using(cfg: AsyncConfig): AsyncConfigBuilder

    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
  30. final def wait(): Unit

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

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

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

    Permalink

    number of parallel workers to use during task

    number of parallel workers to use during task

    Definition Classes
    AsyncConfigBuilderAsyncConfig

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