Click or drag to resize
Akka.NETTestKitBaseAwaitCondition Method (FuncBoolean, NullableTimeSpan, NullableTimeSpan, String)

Await until the given condition evaluates to true or the timeout expires, whichever comes first.

If no timeout is given, take it from the innermost enclosing `within` block.

Note that the timeout is dilated, i.e. scaled by the factor specified in config value "akka.test.timefactor".

The parameter interval specifies the time between calls to conditionIsFulfilled Between calls the thread sleeps. If interval is undefined the thread only sleeps one time, using the max as duration, and then rechecks the condition and ultimately succeeds or fails.

To make sure that tests run as fast as possible, make sure you do not leave this value as undefined, instead set it to a relatively small value.

Namespace:  Akka.TestKit
Assembly:  Akka.TestKit (in Akka.TestKit.dll) Version: 1.2.3.42 (1.2.3.42)
Syntax
Copy
public void AwaitCondition(
	Func<bool> conditionIsFulfilled,
	Nullable<TimeSpan> max,
	Nullable<TimeSpan> interval,
	string message = null
)

Parameters

conditionIsFulfilled
Type: SystemFuncBoolean
The condition that must be fulfilled within the duration.
max
Type: SystemNullableTimeSpan
The maximum duration. If undefined, uses the remaining time (if inside a `within` block) or the value specified in config value "akka.test.single-expect-default". The value is dilated, i.e. scaled by the factor specified in config value "akka.test.timefactor".
interval
Type: SystemNullableTimeSpan
The time between calls to conditionIsFulfilled to check if the condition is fulfilled. Between calls the thread sleeps. If undefined, negative or InfiniteTimeSpanthe thread only sleeps one time, using the max, and then rechecks the condition and ultimately succeeds or fails.

To make sure that tests run as fast as possible, make sure you do not set this value as undefined, instead set it to a relatively small value.

message (Optional)
Type: SystemString
The message used if the timeout expires.
See Also