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
- Alphabetic
- By Inheritance
- AbstractAsyncConfigBuilder
- AsyncConfig
- OptThrottleConfig
- OptRetryConfig
- OptProgressConfig
- OptThrottleConfigBuilder
- OptRetryConfigBuilder
- OptProgressConfigBuilder
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
optProgress: Option[ProgressConfig]
- Definition Classes
- OptProgressConfig
-
abstract
def
optRetry: Option[RetryConfig]
- Definition Classes
- OptRetryConfig
-
abstract
def
optThrottle: Option[ThrottleConfig]
- Definition Classes
- OptThrottleConfig
-
abstract
def
optTotal: Option[Int]
- Definition Classes
- OptProgressConfig
- abstract def using(optProgress: Option[ProgressConfig] = optProgress, optRetry: Option[RetryConfig] = optRetry, optThrottle: Option[ThrottleConfig] = optThrottle): MDT
-
abstract
def
workerCount: Int
- Definition Classes
- AsyncConfig
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
build(): AsyncConfig
- returns
a config instance with the current settings
- Definition Classes
- AbstractAsyncConfigBuilder → OptThrottleConfigBuilder → OptRetryConfigBuilder → OptProgressConfigBuilder
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
progress(r: TaskEventListener)(implicit ec: ExecutionContext): MDT
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
-
def
progress(reportInterval: FiniteDuration)(report: (Progress) ⇒ Unit)(implicit executionContext: ExecutionContext, scheduledExecutionContext: ScheduledExecutionContext): MDT
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
-
def
progress(report: (Progress) ⇒ Unit)(implicit ec: ExecutionContext): MDT
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
-
def
retry(f: (List[Throwable]) ⇒ Future[Boolean])(implicit ec: ExecutionContext): MDT
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
-
def
retryDecider(r: RetryDecider)(implicit ec: ExecutionContext): MDT
Set the optional retry function
Set the optional retry function
- returns
a copy of the builder with the new setting
- Definition Classes
- AbstractAsyncConfigBuilder → OptRetryConfigBuilder
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
throttle(_throttle: Duration)(implicit scheduledExecutionContext: ScheduledExecutionContext): MDT
Set the optional throttle period
Set the optional throttle period
- _throttle
the throttle period
- Definition Classes
- OptThrottleConfigBuilder
-
def
throttle_ns(_throttle_ns: Long)(implicit sec: ScheduledExecutionContext): MDT
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
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
using(cfg: AsyncConfig): MDT
Copy an existing configuration
Copy an existing configuration
- cfg
configuration to use
- returns
a copy of the builder with all settings copied from cfg
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )