PatienceConfiguration

Trait providing methods and classes used to configure timeouts and, where relevant, the interval between retries.

This trait is called PatienceConfiguration because it allows configuration of two values related to patience: The timeout specifies how much time asynchronous operations will be given to succeed before giving up. The interval specifies how much time to wait between checks to determine success when polling.

The default values for timeout and interval provided by trait PatienceConfiguration are tuned for unit testing, where running tests as fast as possible is a high priority and subsystems requiring asynchronous operations are therefore often replaced by mocks. This table shows the default values:

Configuration Parameter	Default Value
`timeout`	`scaled(150 milliseconds)`
`interval`	`scaled(15 milliseconds)`

Values more appropriate to integration testing, where asynchronous operations tend to take longer because the tests are run against the actual subsytems (not mocks), can be obtained by mixing in trait IntegrationPatience.

The default values of both timeout and interval are passed to the scaled method, inherited from ScaledTimeSpans, so that the defaults can be scaled up or down together with other scaled time spans. See the documentation for trait ScaledTimeSpans for more information.

Timeouts are used by the eventually methods of trait Eventually and the await method of class Waiter, a member of trait Waiters. Intervals are used by the eventually methods.

Source: PatienceConfiguration.scala

Linear Supertypes

AbstractPatienceConfiguration, ScaledTimeSpans, AnyRef, Any

Known Subclasses

ConductorFixture, ConductorMethods, Conductors, Eventually, Eventually, Futures, JavaFutures, ScalaFutures, ScalaFutures, Waiters, Waiters

Type Members

final case class PatienceConfig(timeout: Span = scaled(Span(150, Millis)), interval: Span = scaled(Span(15, Millis))) extends Product with Serializable

Configuration object for asynchronous constructs, such as those provided by traits Eventually and Waiters.
Configuration object for asynchronous constructs, such as those provided by traits Eventually and Waiters.
The default values for the parameters are:

Configuration Parameter Default Value

timeout scaled(150 milliseconds)

interval scaled(15 milliseconds)

timeout
the maximum amount of time to wait for an asynchronous operation to complete before giving up and throwing TestFailedException.
interval
the amount of time to sleep between each check of the status of an asynchronous operation when polling

Definition Classes
AbstractPatienceConfiguration

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 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
def interval(value: Span): Interval

Returns an Interval configuration parameter containing the passed value, which specifies the amount of time to sleep after a retry.
Returns an Interval configuration parameter containing the passed value, which specifies the amount of time to sleep after a retry.
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
implicit def patienceConfig: PatienceConfig

Implicit PatienceConfig value providing default configuration values.
Implicit PatienceConfig value providing default configuration values.
To change the default configuration, override or hide this def with another implicit PatienceConfig containing your desired default configuration values.

Definition Classes
PatienceConfiguration → AbstractPatienceConfiguration
final def scaled(span: Span): Span

Scales the passed Span by the Double factor returned by spanScaleFactor.
Scales the passed Span by the Double factor returned by spanScaleFactor.
The Span is scaled by invoking its scaledBy method, thus this method has the same behavior: The value returned by spanScaleFactor can be any positive number or zero, including a fractional number. A number greater than one will scale the Span up to a larger value. A fractional number will scale it down to a smaller value. A factor of 1.0 will cause the exact same Span to be returned. A factor of zero will cause Span.ZeroLength to be returned. If overflow occurs, Span.Max will be returned. If underflow occurs, Span.ZeroLength will be returned.

Definition Classes
ScaledTimeSpans
Exceptions thrown
IllegalArgumentException if the value returned from spanScaleFactor is less than zero
def spanScaleFactor: Double

The factor by which the scaled method will scale Spans.
The factor by which the scaled method will scale Spans.
The default implementation of this method will return the span scale factor that was specified for the run, or 1.0 if no factor was specified. For example, you can specify a span scale factor when invoking ScalaTest via the command line by passing a -F argument to Runner.

Definition Classes
ScaledTimeSpans
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def timeout(value: Span): Timeout

Returns a Timeout configuration parameter containing the passed value, which specifies the maximum amount to wait for an asynchronous operation to complete.
Returns a Timeout configuration parameter containing the passed value, which specifies the maximum amount to wait for an asynchronous operation to complete.
def toString(): String

Definition Classes
AnyRef → Any
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( ... )

Related Docs: object PatienceConfiguration | package concurrent

trait PatienceConfiguration extends AbstractPatienceConfiguration

Type Members

final case class PatienceConfig(timeout: Span = scaled(Span(150, Millis)), interval: Span = scaled(Span(15, Millis))) extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def interval(value: Span): Interval

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

implicit def patienceConfig: PatienceConfig

final def scaled(span: Span): Span

def spanScaleFactor: Double

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

def timeout(value: Span): Timeout

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AbstractPatienceConfiguration

Inherited from ScaledTimeSpans

Inherited from AnyRef

Inherited from Any

Ungrouped