Click or drag to resize
Akka.NETTestKit Class
TestKit for xUnit.
Inheritance Hierarchy

Namespace:  Akka.TestKit.Xunit
Assembly:  Akka.TestKit.Xunit (in Akka.TestKit.Xunit.dll) Version: 1.2.3.42 (1.2.3.42)
Syntax
Copy
public class TestKit : TestKitBase, IDisposable

The TestKit type exposes the following members.

Constructors
  NameDescription
Public methodTestKit(String, ITestOutputHelper)
Create a new instance of the TestKit for xUnit class. A new system with the specified configuration will be created.
Public methodTestKit(ActorSystem, ITestOutputHelper)
Create a new instance of the TestKit for xUnit class. If no system is passed in, a new system with DefaultConfig will be created.
Public methodTestKit(Config, String, ITestOutputHelper)
Create a new instance of the TestKit for xUnit class. A new system with the specified configuration will be created.
Top
Properties
  NameDescription
Protected propertyStatic memberAssertions
TBD
Public propertyStatic memberDefaultConfig
TBD
Public propertyEventFilter
Filter LogEvent sent to the system's EventStream. In order to be able to filter the log the special logger TestEventListener must be installed using the config
Copy
akka.loggers = ["Akka.TestKit.TestEventListener, Akka.TestKit"]
It is installed by default in testkit.
(Inherited from TestKitBase.)
Public propertyStatic memberFullDebugConfig
TBD
Public propertyHasMessages
Returns true if messages are available.
(Inherited from TestKitBase.)
Public propertyLastMessage
The last message received by the TestActor.
(Inherited from TestKitBase.)
Public propertyLastSender
The last IActorRef to send a message to the TestActor.
(Inherited from TestKitBase.)
Public propertyLog
The built-in ILoggingAdapter used by Sys.
(Inherited from TestKitBase.)
Public propertyRemaining

Retrieves the time remaining for execution of the innermost enclosing Within block.

Remarks
The returned value is always finite.
(Inherited from TestKitBase.)
Public propertyRemainingOrDefault

Retrieves the time remaining for execution of the innermost enclosing Within block. If missing that, then it returns the properly dilated default for this case from settings (key: "akka.test.single-expect-default").

Remarks
The returned value is always finite.
(Inherited from TestKitBase.)
Public propertySys
The ActorSystem that is recreated and used for each test.
(Inherited from TestKitBase.)
Public propertyTestActor
The default TestActor. The actor can be controlled by sending it special control messages, see TestActorSetIgnore, TestActorWatch, TestActorUnwatch. You can also install an AutoPilot to drive the actor, see SetAutoPilot(AutoPilot). All other messages are forwarded to the queue and can be retrieved with Receive and the ExpectMsg overloads.
(Inherited from TestKitBase.)
Public propertyTestKitSettings
The settings for the testkit.
(Inherited from TestKitBase.)
Top
Methods
  NameDescription
Public methodActorOf(Props)
Create a new actor as child of Sys.
(Inherited from TestKitBase.)
Public methodCode exampleActorOf(ActionIActorDsl, String)
Creates a new actor by defining the behavior inside the configure action.
Examples
Copy
ActorOf(c =>
{
    c.Receive<string>((msg, ctx) => ctx.Sender.Tell("Hello " + msg));
});
(Inherited from TestKitBase.)
Public methodCode exampleActorOf(ActionIActorDsl, IActorContext, String)
Creates a new actor by defining the behavior inside the configure action.
Examples
Copy
ActorOf(c =>
{
    c.Receive<string>((msg, ctx) => ctx.Sender.Tell("Hello " + msg));
});
(Inherited from TestKitBase.)
Public methodActorOf(Props, String)
Create a new actor as child of Sys.
(Inherited from TestKitBase.)
Public methodActorOfTActor
Create a new actor as child of Sys.
(Inherited from TestKitBase.)
Public methodCode exampleActorOfTActor(ExpressionFuncTActor)
Create a new actor as child of Sys using an expression that calls the constructor of TActor.
Examples
Copy
ActorOf<MyActor>(()=>new MyActor("value", 4711))
(Inherited from TestKitBase.)
Public methodActorOfTActor(String)
Create a new actor as child of Sys.
(Inherited from TestKitBase.)
Public methodCode exampleActorOfTActor(ExpressionFuncTActor, String)
Create a new actor as child of Sys using an expression that calls the constructor of TActor.
Examples
Copy
ActorOf<MyActor>(()=>new MyActor("value", 4711), "test-actor")
(Inherited from TestKitBase.)
Public methodActorOfAsTestActorRefTActor(String)
Create a new actor as child of Sys and returns it as TestActorRefTActor to enable access to the underlying actor instance via UnderlyingActor.
(Inherited from TestKitBase.)
Public methodCode exampleActorOfAsTestActorRefTActor(ExpressionFuncTActor, String)
Create a new actor as child of Sys and returns it as TestActorRefTActor to enable access to the underlying actor instance via UnderlyingActor. Uses an expression that calls the constructor of TActor.
Examples
Copy
ActorOf<MyActor>(()=>new MyActor("value", 4711), "test-actor")
(Inherited from TestKitBase.)
Public methodActorOfAsTestActorRefTActor(IActorRef, String)
Create a new actor as child of the specified supervisor and returns it as TestActorRefTActor to enable access to the underlying actor instance via UnderlyingActor.
(Inherited from TestKitBase.)
Public methodActorOfAsTestActorRefTActor(Props, String)
Create a new actor as child of Sys and returns it as TestActorRefTActor to enable access to the underlying actor instance via UnderlyingActor.
(Inherited from TestKitBase.)
Public methodCode exampleActorOfAsTestActorRefTActor(ExpressionFuncTActor, IActorRef, String)
Create a new actor as child of the specified supervisor and returns it as TestActorRefTActor to enable access to the underlying actor instance via UnderlyingActor. Uses an expression that calls the constructor of TActor.
Examples
Copy
ActorOf<MyActor>(()=>new MyActor("value", 4711), "test-actor")
(Inherited from TestKitBase.)
Public methodActorOfAsTestActorRefTActor(Props, IActorRef, String)
Create a new actor as child of specified supervisor and returns it as TestActorRefTActor to enable access to the underlying actor instance via UnderlyingActor.
(Inherited from TestKitBase.)
Public methodActorOfAsTestFSMRefTFsmActor, TState, TData(String, Boolean)
Create a new FSMTState, TData as child of Sys and returns it as TestFSMRefTActor, TState, TData to enable inspecting and modifying the FSM directly. TFsmActor must have a public parameterless constructor.
(Inherited from TestKitBase.)
Public methodActorOfAsTestFSMRefTFsmActor, TState, TData(ExpressionFuncTFsmActor, String, Boolean)
Create a new FSMTState, TData as child of Sys and returns it as TestFSMRefTActor, TState, TData to enable inspecting and modifying the FSM directly. Uses an expression that calls the constructor of TFsmActor.
(Inherited from TestKitBase.)
Public methodActorOfAsTestFSMRefTFsmActor, TState, TData(IActorRef, String, Boolean)
Create a new FSMTState, TData as child of the specified supervisor and returns it as TestFSMRefTActor, TState, TData to enable inspecting and modifying the FSM directly. TFsmActor must have a public parameterless constructor.
(Inherited from TestKitBase.)
Public methodActorOfAsTestFSMRefTFsmActor, TState, TData(Props, String, Boolean)
Create a new FSMTState, TData as child of Sys and returns it as TestFSMRefTActor, TState, TData to enable inspecting and modifying the FSM directly.
(Inherited from TestKitBase.)
Public methodActorOfAsTestFSMRefTFsmActor, TState, TData(ExpressionFuncTFsmActor, IActorRef, String, Boolean)
Create a new FSMTState, TData as child of the specified supervisor and returns it as TestFSMRefTActor, TState, TData to enable inspecting and modifying the FSM directly. Uses an expression that calls the constructor of TFsmActor.
(Inherited from TestKitBase.)
Public methodActorOfAsTestFSMRefTFsmActor, TState, TData(Props, IActorRef, String, Boolean)
Create a new FSMTState, TData as child of the specified supervisor and returns it as TestFSMRefTActor, TState, TData to enable inspecting and modifying the FSM directly.
(Inherited from TestKitBase.)
Public methodActorSelection(String)
Creates an ActorSelection(String)
(Inherited from TestKitBase.)
Public methodActorSelection(ActorPath)
Creates an ActorSelection(ActorPath)
(Inherited from TestKitBase.)
Public methodActorSelection(IActorRef, String)
Creates an ActorSelection(String)
(Inherited from TestKitBase.)
Protected methodAfterAll
This method is called when a test ends.
Remarks
If you override this, make sure you either call base.AfterTest() or TestKitBase.Shutdown to shut down the system. Otherwise you'll leak memory.
Public methodAwaitAssert

Await until the given assertion does not throw an exception or the timeout expires, whichever comes first. If the timeout expires the last exception is thrown.

The action is called, and if it throws an exception the thread sleeps the specified interval before retrying.

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

Note that the timeout is scaled using Dilated(TimeSpan), which uses the configuration entry "akka.test.timefactor".

(Inherited from TestKitBase.)
Public methodAwaitCondition(FuncBoolean)

Await until the given condition evaluates to true or until a timeout

The timeout is taken from the innermost enclosing `within` block (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"..

A call to conditionIsFulfilled is done immediately, then the threads sleep for about a tenth of the timeout value, before it checks the condition again. This is repeated until timeout or the condition evaluates to true. To specify another interval, use the overload AwaitCondition(FuncBoolean, NullableTimeSpan, NullableTimeSpan, String)

(Inherited from TestKitBase.)
Public methodAwaitCondition(FuncBoolean, NullableTimeSpan)

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 (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"..

A call to conditionIsFulfilled is done immediately, then the threads sleep for about a tenth of the timeout value, before it checks the condition again. This is repeated until timeout or the condition evaluates to true. To specify another interval, use the overload AwaitCondition(FuncBoolean, NullableTimeSpan, NullableTimeSpan, String)

(Inherited from TestKitBase.)
Public methodAwaitCondition(FuncBoolean, 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 (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"..

A call to conditionIsFulfilled is done immediately, then the threads sleep for about a tenth of the timeout value, before it checks the condition again. This is repeated until timeout or the condition evaluates to true. To specify another interval, use the overload AwaitCondition(FuncBoolean, NullableTimeSpan, NullableTimeSpan, String)

(Inherited from TestKitBase.)
Public methodAwaitCondition(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.

(Inherited from TestKitBase.)
Public methodAwaitConditionNoThrow

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

The parameter interval specifies the time between calls to conditionIsFulfilled Between calls the thread sleeps. If interval is not specified or null 100 ms is used.

(Inherited from TestKitBase.)
Public methodCreateEventFilter
Creates a new event filter for the specified actor system.
(Inherited from TestKitBase.)
Public methodCreateTestActor
Creates a test actor with the specified name. The actor can be controlled by sending it special control messages, see TestActorSetIgnore, TestActorWatch, TestActorUnwatch, TestActorSetAutoPilot. All other messages are forwarded to the queue and can be retrieved with Receive and the ExpectMsg overloads.

The default test actor can be retrieved from the TestActor property

(Inherited from TestKitBase.)
Public methodCreateTestBarrier
Wraps a Barrier for use in testing. It always uses a timeout when waiting. Timeouts will always throw an exception. The default timeout is 5 seconds.
(Inherited from TestKitBase.)
Public methodCreateTestLatch
Creates a Countdown latch wrapper for use in testing. It uses a timeout when waiting and timeouts are specified as durations. There's a default timeout of 5 seconds and the default count is 1. Timeouts will always throw an exception.
(Inherited from TestKitBase.)
Public methodCreateTestProbe(String)
Creates a new TestProbe.
(Inherited from TestKitBase.)
Public methodCreateTestProbe(ActorSystem, String)
Creates a new TestProbe.
(Inherited from TestKitBase.)
Public methodDilated
Multiplies the duration with the TestTimeFactor, i.e. the config value "akka.test.timefactor"
(Inherited from TestKitBase.)
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Protected methodDispose(Boolean)
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExpectMsgT(NullableTimeSpan, String)
Receive one message from the test actor and assert that it is of the specified type. Wait time is bounded by the given duration, if specified; otherwise wait time is bounded by remaining time for execution of the innermost enclosing 'within' block, if inside a 'within' block; otherwise by the config value "akka.test.single-expect-default".
(Inherited from TestKitBase.)
Public methodExpectMsgT(ActionT, NullableTimeSpan, String)
Receive one message of the specified type from the test actor and calls the action that performs extra assertions. Use this variant to implement more complicated or conditional processing. Wait time is bounded by the given duration, if specified; otherwise wait time is bounded by remaining time for execution of the innermost enclosing 'within' block, if inside a 'within' block; otherwise by the config value "akka.test.single-expect-default".
(Inherited from TestKitBase.)
Public methodExpectMsgT(PredicateT, NullableTimeSpan, String)
Receive one message of the specified type from the test actor and assert that the given predicate accepts it. Use this variant to implement more complicated or conditional processing. Wait time is bounded by the given duration, if specified; otherwise wait time is bounded by remaining time for execution of the innermost enclosing 'within' block, if inside a 'within' block; otherwise by the config value "akka.test.single-expect-default".
(Inherited from TestKitBase.)
Public methodExpectMsgT(T, NullableTimeSpan, String)
Receive one message of the specified type from the test actor and assert that it equals the message. Wait time is bounded by the given duration, if specified; otherwise wait time is bounded by remaining time for execution of the innermost enclosing 'within' block, if inside a 'within' block; otherwise by the config value "akka.test.single-expect-default".
(Inherited from TestKitBase.)
Public methodExpectMsgT(ActionT, IActorRef, NullableTimeSpan, String)
Receive one message of the specified type from the test actor calls the action that performs extra assertions. Use this variant to implement more complicated or conditional processing. Wait time is bounded by the given duration, if specified; otherwise wait time is bounded by remaining time for execution of the innermost enclosing 'within' block, if inside a 'within' block; otherwise by the config value "akka.test.single-expect-default".
(Inherited from TestKitBase.)
Public methodExpectMsgT(FuncT, IActorRef, Boolean, NullableTimeSpan, String)
Receive one message of the specified type from the test actor and assert that the given predicate accepts it. Use this variant to implement more complicated or conditional processing. Wait time is bounded by the given duration, if specified; otherwise wait time is bounded by remaining time for execution of the innermost enclosing 'within' block, if inside a 'within' block; otherwise by the config value "akka.test.single-expect-default".
(Inherited from TestKitBase.)
Public methodExpectMsgT(T, FuncT, T, Boolean, NullableTimeSpan, String)
Receive one message from the test actor and assert that it is equal to the expected value, according to the specified comparer function. Wait time is bounded by remaining time for execution of the innermost enclosing 'within' block, if inside a 'within' block; otherwise by the config value "akka.test.single-expect-default".
(Inherited from TestKitBase.)
Public methodExpectMsgAllOfT(T)
Receive a number of messages from the test actor matching the given number of objects and assert that for each given object one is received which equals it and vice versa. This construct is useful when the order in which the objects are received is not fixed. Wait time is bounded by RemainingOrDefault as duration, with an assertion exception being thrown in case of timeout.
Copy
dispatcher.Tell(SomeWork1())
dispatcher.Tell(SomeWork2())
ExpectMsgAllOf(TimeSpan.FromSeconds(1), Result1(), Result2())
(Inherited from TestKitBase.)
Public methodExpectMsgAllOfT(TimeSpan, T)
Receive a number of messages from the test actor matching the given number of objects and assert that for each given object one is received which equals it and vice versa. This construct is useful when the order in which the objects are received is not fixed. Wait time is bounded by the given duration, with an assertion exception being thrown in case of timeout.
Copy
dispatcher.Tell(SomeWork1())
dispatcher.Tell(SomeWork2())
ExpectMsgAllOf(TimeSpan.FromSeconds(1), Result1(), Result2())
The deadline is scaled by "akka.test.timefactor" using Dilated(TimeSpan).
(Inherited from TestKitBase.)
Public methodExpectMsgAnyOfT
Receive a message from the test actor and assert that it equals one of the given messages. Wait time is bounded by RemainingOrDefault as duration, with an assertion exception being thrown in case of timeout.
(Inherited from TestKitBase.)
Public methodExpectMsgFromT(IActorRef, NullableTimeSpan, String)
Receive one message from the test actor and assert that it is of the specified type and was sent by the specified sender Wait time is bounded by the given duration if specified. If not specified, wait time is bounded by remaining time for execution of the innermost enclosing 'within' block, if inside a 'within' block; otherwise by the config value "akka.test.single-expect-default".
(Inherited from TestKitBase.)
Public methodExpectMsgFromT(IActorRef, ActionT, NullableTimeSpan, String)
Receive one message of the specified type from the test actor, verifies that the sender is the specified and calls the action that performs extra assertions. Wait time is bounded by the given duration if specified. If not specified, wait time is bounded by remaining time for execution of the innermost enclosing 'within' block, if inside a 'within' block; otherwise by the config value "akka.test.single-expect-default". Use this variant to implement more complicated or conditional processing.
(Inherited from TestKitBase.)
Public methodExpectMsgFromT(IActorRef, PredicateT, NullableTimeSpan, String)
Receive one message of the specified type from the test actor and assert that the given predicate accepts it and was sent by the specified sender Wait time is bounded by the given duration if specified. If not specified, wait time is bounded by remaining time for execution of the innermost enclosing 'within' block, if inside a 'within' block; otherwise by the config value "akka.test.single-expect-default". Use this variant to implement more complicated or conditional processing.
(Inherited from TestKitBase.)
Public methodExpectMsgFromT(IActorRef, T, NullableTimeSpan, String)
Receive one message of the specified type from the test actor and assert that it equals the message and was sent by the specified sender Wait time is bounded by the given duration if specified. If not specified, wait time is bounded by remaining time for execution of the innermost enclosing 'within' block, if inside a 'within' block; otherwise by the config value "akka.test.single-expect-default".
(Inherited from TestKitBase.)
Public methodExpectMsgFromT(ActionIActorRef, ActionT, NullableTimeSpan, String)
Receive one message of the specified type from the test actor and calls the action that performs extra assertions. Wait time is bounded by the given duration if specified. If not specified, wait time is bounded by remaining time for execution of the innermost enclosing 'within' block, if inside a 'within' block; otherwise by the config value "akka.test.single-expect-default". Use this variant to implement more complicated or conditional processing.
(Inherited from TestKitBase.)
Public methodExpectMsgFromT(PredicateIActorRef, PredicateT, NullableTimeSpan, String)
Receive one message of the specified type from the test actor and assert that the given predicate accepts it and was sent by a sender that matches the isSender predicate. Wait time is bounded by the given duration if specified. If not specified, wait time is bounded by remaining time for execution of the innermost enclosing 'within' block, if inside a 'within' block; otherwise by the config value "akka.test.single-expect-default". Use this variant to implement more complicated or conditional processing.
(Inherited from TestKitBase.)
Public methodExpectNoMsg
Assert that no message is received. Wait time is bounded by remaining time for execution of the innermost enclosing 'within' block, if inside a 'within' block; otherwise by the config value "akka.test.single-expect-default".
(Inherited from TestKitBase.)
Public methodExpectNoMsg(Int32)
Assert that no message is received for the specified time in milliseconds.
(Inherited from TestKitBase.)
Public methodExpectNoMsg(TimeSpan)
Assert that no message is received for the specified time.
(Inherited from TestKitBase.)
Public methodExpectTerminated
Receive one message from the test actor and assert that it is the Terminated message of the given ActorRef. Wait time is bounded by the given duration, if specified; otherwise wait time is bounded by remaining time for execution of the innermost enclosing 'within' block, if inside a 'within' block; otherwise by the config value "akka.test.single-expect-default".
(Inherited from TestKitBase.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFishForMessage(PredicateObject, NullableTimeSpan, String)
Receives messages until isMessage returns true. Use it to ignore certain messages while waiting for a specific message.
(Inherited from TestKitBase.)
Public methodFishForMessageT(PredicateT, NullableTimeSpan, String)
Receives messages until isMessage returns true. Use it to ignore certain messages while waiting for a specific message.
(Inherited from TestKitBase.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetTimeoutOrDefault
If timeout is defined it is returned; otherwise the config value "akka.test.single-expect-default" is returned.
(Inherited from TestKitBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIgnoreMessages
Ignore all messages in the test actor for which the given function returns true.
(Inherited from TestKitBase.)
Public methodIgnoreNoMessages
Stop ignoring messages in the test actor.
(Inherited from TestKitBase.)
Protected methodInitializeLogger
Protected methodInitializeTest
Initializes the TestState for a new spec.
(Inherited from TestKitBase.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodReceiveN(Int32)
Receive the specified number of messages using RemainingOrDefault as timeout.
(Inherited from TestKitBase.)
Public methodReceiveN(Int32, TimeSpan)
Receive the specified number of messages in a row before the given deadline. The deadline is scaled by "akka.test.timefactor" using Dilated(TimeSpan).
(Inherited from TestKitBase.)
Public methodReceiveOne(NullableTimeSpan)
Receive one message from the internal queue of the TestActor. This method blocks the specified duration or until a message is received. If no message was received, null is returned.
Remarks
This method does NOT automatically scale its Duration parameter using Dilated(TimeSpan)!
(Inherited from TestKitBase.)
Public methodReceiveOne(CancellationToken)
Receive one message from the internal queue of the TestActor. This method blocks until cancelled.
(Inherited from TestKitBase.)
Public methodReceiveWhileT(NullableTimeSpan, FuncObject, T, Int32)
Receive a series of messages until the function returns null or the overall maximum duration is elapsed or expected messages count is reached. Returns the sequence of messages. Note that it is not an error to hit the `max` duration in this case. The max duration is scaled by Dilated(TimeSpan)
(Inherited from TestKitBase.)
Public methodReceiveWhileT(FuncObject, T, NullableTimeSpan, NullableTimeSpan, Int32)
Receive a series of messages until the function returns null or the idle timeout is met (disabled by default) or the overall maximum duration is elapsed or expected messages count is reached. Returns the sequence of messages. Note that it is not an error to hit the `max` duration in this case. The max duration is scaled by Dilated(TimeSpan)
(Inherited from TestKitBase.)
Public methodReceiveWhileT(NullableTimeSpan, NullableTimeSpan, FuncObject, T, Int32)
Receive a series of messages until the function returns null or the idle timeout is met or the overall maximum duration is elapsed or expected messages count is reached. Returns the sequence of messages. Note that it is not an error to hit the `max` duration in this case. The max duration is scaled by Dilated(TimeSpan)
(Inherited from TestKitBase.)
Public methodReceiveWhileT(PredicateT, NullableTimeSpan, NullableTimeSpan, Int32, Boolean)
Receive a series of messages. It will continue to receive messages until the shouldIgnore predicate returns false or the idle timeout is met (disabled by default) or the overall maximum duration is elapsed or expected messages count is reached. If a message that isn't of type T the parameter shouldIgnoreOtherMessageTypes declares if the message should be ignored or not.

Returns the sequence of messages.

Note that it is not an error to hit the `max` duration in this case. The max duration is scaled by Dilated(TimeSpan)
(Inherited from TestKitBase.)
Protected methodRemainingOr
If inside a `within` block obtain time remaining for execution of the innermost enclosing `within` block; otherwise returns the given duration.
(Inherited from TestKitBase.)
Public methodRemainingOrDilated
If duration is finite it is returned after it has been scaled using Dilated(TimeSpan). If duration is undefined, it returns the remaining time (if within a `within` block) or the properly dilated default from settings (key "akka.test.single-expect-default"). If duration is infinite, an ArgumentException is thrown.
Remarks
The returned value is always finite.
(Inherited from TestKitBase.)
Public methodSetAutoPilot

Install an AutoPilot to drive the TestActor. The AutoPilot will be run for each received message and can be used to send or forward messages, etc.

Each invocation must return the AutoPilot for the next round. To reuse the same AutoPilot return KeepRunning.

(Inherited from TestKitBase.)
Public methodShutdown(NullableTimeSpan, Boolean)
Shuts down this system. On failure debug output will be logged about the remaining actors in the system. If verifySystemShutdown is true, then an exception will be thrown on failure.
(Inherited from TestKitBase.)
Protected methodShutdown(ActorSystem, NullableTimeSpan, Boolean)
Shuts down the specified system. On failure debug output will be logged about the remaining actors in the system. If verifySystemShutdown is true, then an exception will be thrown on failure.
(Inherited from TestKitBase.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryReceiveOne(MessageEnvelope, NullableTimeSpan)
Receive one message from the internal queue of the TestActor within the specified duration. The method blocks the specified duration.
Remarks
Note! that the returned envelope is a MessageEnvelope containing the sender and the message.
Remarks
This method does NOT automatically scale its Duration parameter using Dilated(TimeSpan)!
(Inherited from TestKitBase.)
Public methodTryReceiveOne(MessageEnvelope, NullableTimeSpan, CancellationToken)
Receive one message from the internal queue of the TestActor within the specified duration.

True is returned if a message existed, and the message is returned in envelope. The method blocks the specified duration, and can be cancelled using the cancellationToken.

Remarks
This method does NOT automatically scale its duration parameter using Dilated(TimeSpan)!
(Inherited from TestKitBase.)
Public methodUnwatch
Have the TestActor stop watching an actor.
(Inherited from TestKitBase.)
Public methodWatch
Have the TestActor watch an actor and receive Terminated messages when the actor terminates.
(Inherited from TestKitBase.)
Public methodWithin(TimeSpan, Action, NullableTimeSpan)
Execute code block while bounding its execution time between 0 seconds and max.

`within` blocks may be nested. All methods in this class which take maximum wait times are available in a version which implicitly uses the remaining time governed by the innermost enclosing `within` block.

Remarks
Note that the max duration is scaled using Dilated(TimeSpan) which uses the config value "akka.test.timefactor"
(Inherited from TestKitBase.)
Public methodWithin(TimeSpan, TimeSpan, Action, String, NullableTimeSpan)
Execute code block while bounding its execution time between min and max.

`within` blocks may be nested. All methods in this class which take maximum wait times are available in a version which implicitly uses the remaining time governed by the innermost enclosing `within` block.

Remarks
Note that the max duration is scaled using Dilated(TimeSpan) which uses the config value "akka.test.timefactor"
(Inherited from TestKitBase.)
Public methodWithinT(TimeSpan, FuncT, NullableTimeSpan)
Execute code block while bounding its execution time between 0 seconds and max.

`within` blocks may be nested. All methods in this class which take maximum wait times are available in a version which implicitly uses the remaining time governed by the innermost enclosing `within` block.

Remarks
Note that the max duration is scaled using Dilated(TimeSpan) which uses the config value "akka.test.timefactor"
(Inherited from TestKitBase.)
Public methodWithinT(TimeSpan, TimeSpan, FuncT, String, NullableTimeSpan)
Execute code block while bounding its execution time between min and max.

`within` blocks may be nested. All methods in this class which take maximum wait times are available in a version which implicitly uses the remaining time governed by the innermost enclosing `within` block.

Remarks
Note that the max duration is scaled using Dilated(TimeSpan) which uses the config value "akka.test.timefactor"
(Inherited from TestKitBase.)
Top
Fields
  NameDescription
Protected fieldOutput
Top
Extension Methods
  NameDescription
Public Extension MethodAsInstanceOfT
TBD
(Defined by Extensions.)
Public Extension MethodCreateManualPublisherProbeT
Probe that implements IPublisher interface.
(Defined by TestPublisher.)
Public Extension MethodCreateManualSubscriberProbeT (Defined by TestSubscriber.)
Public Extension MethodCreatePublisherProbeT (Defined by TestPublisher.)
Public Extension MethodCreateSubscriberProbeT (Defined by TestSubscriber.)
Public Extension MethodMatchOverloaded.
Matches the specified target.
(Defined by PatternMatch.)
Public Extension MethodMatchTOverloaded.
Matches the specified target and return a result of target processing.
(Defined by PatternMatch.)
Public Extension MethodSinkProbeT
A Sink that materialized to a TestSubscriberProbeT.
(Defined by TestSink.)
Public Extension MethodSourceProbeT
A Source that materializes to a TestPublisherProbeT.
(Defined by TestSource.)
Top
See Also