Class TestProbe

TestKit-based probe which allows sending, reception and reply. Use CreateTestProbe(String) inside your test to create new instances.

Inheritance
Object
TestKitBase
TestProbe
Implements
Inherited Members
Namespace: Akka.TestKit
Assembly: Akka.TestKit.dll
Syntax
public class TestProbe : TestKitBase, IActorRefFactory, INoImplicitSender, IInternalActorRef, IActorRef, ICanTell, IEquatable<IActorRef>, IComparable<IActorRef>, ISurrogated, IComparable, IActorRefScope

Constructors

| Improve this Doc View Source

TestProbe(ActorSystem, ITestKitAssertions, String)

TBD

Declaration
public TestProbe(ActorSystem system, ITestKitAssertions assertions, string testProbeName = null)
Parameters
Type Name Description
ActorSystem system

TBD
ITestKitAssertions assertions

TBD
String testProbeName

TBD

Properties

| Improve this Doc View Source

Ref

Gets the reference of this probe.

Declaration
public IActorRef Ref { get; }
Property Value
Type Description
IActorRef
| Improve this Doc View Source

Sender

Gets the sender of the last message

Declaration
public IActorRef Sender { get; }
Property Value
Type Description
IActorRef

Methods

| Improve this Doc View Source

ChildActorOf<T>(SupervisorStrategy, CancellationToken)

Spawns an actor as a child of this test actor, and returns the child's ActorRef.

Declaration
public IActorRef ChildActorOf<T>(SupervisorStrategy supervisorStrategy, CancellationToken cancellationToken = default(CancellationToken))
    where T : ActorBase
Parameters
Type Name Description
SupervisorStrategy supervisorStrategy
CancellationToken cancellationToken

CancellationToken to cancel the operation
Returns
Type Description
IActorRef
Type Parameters
Name Description
T
| Improve this Doc View Source

ChildActorOf<T>(String, SupervisorStrategy, CancellationToken)

Spawns an actor as a child of this test actor, and returns the child's ActorRef.

Declaration
public IActorRef ChildActorOf<T>(string name, SupervisorStrategy supervisorStrategy, CancellationToken cancellationToken = default(CancellationToken))
    where T : ActorBase
Parameters
Type Name Description
String name
SupervisorStrategy supervisorStrategy
CancellationToken cancellationToken

CancellationToken to cancel the operation
Returns
Type Description
IActorRef
Type Parameters
Name Description
T
| Improve this Doc View Source

ChildActorOf<T>(String, CancellationToken)

Spawns an actor as a child of this test actor, and returns the child's ActorRef.

Declaration
public IActorRef ChildActorOf<T>(string name, CancellationToken cancellationToken = default(CancellationToken))
    where T : ActorBase
Parameters
Type Name Description
String name
CancellationToken cancellationToken

CancellationToken to cancel the operation
Returns
Type Description
IActorRef
Type Parameters
Name Description
T
| Improve this Doc View Source

ChildActorOf<T>(CancellationToken)

Spawns an actor as a child of this test actor, and returns the child's ActorRef.

Declaration
public IActorRef ChildActorOf<T>(CancellationToken cancellationToken = default(CancellationToken))
    where T : ActorBase
Parameters
Type Name Description
CancellationToken cancellationToken

CancellationToken to cancel the operation
Returns
Type Description
IActorRef
Type Parameters
Name Description
T
| Improve this Doc View Source

ChildActorOfAsync<T>(SupervisorStrategy, CancellationToken)

Spawns an actor as a child of this test actor, and returns the child's ActorRef.

Declaration
public async Task<IActorRef> ChildActorOfAsync<T>(SupervisorStrategy supervisorStrategy, CancellationToken cancellationToken = default(CancellationToken))
    where T : ActorBase
Parameters
Type Name Description
SupervisorStrategy supervisorStrategy
CancellationToken cancellationToken

CancellationToken to cancel the operation
Returns
Type Description
Task<IActorRef>
Type Parameters
Name Description
T
| Improve this Doc View Source

ChildActorOfAsync<T>(String, SupervisorStrategy, CancellationToken)

Spawns an actor as a child of this test actor, and returns the child's ActorRef.

Declaration
public async Task<IActorRef> ChildActorOfAsync<T>(string name, SupervisorStrategy supervisorStrategy, CancellationToken cancellationToken = default(CancellationToken))
    where T : ActorBase
Parameters
Type Name Description
String name
SupervisorStrategy supervisorStrategy
CancellationToken cancellationToken

CancellationToken to cancel the operation
Returns
Type Description
Task<IActorRef>
Type Parameters
Name Description
T
| Improve this Doc View Source

ChildActorOfAsync<T>(String, CancellationToken)

Spawns an actor as a child of this test actor, and returns the child's ActorRef.

Declaration
public async Task<IActorRef> ChildActorOfAsync<T>(string name, CancellationToken cancellationToken = default(CancellationToken))
    where T : ActorBase
Parameters
Type Name Description
String name
CancellationToken cancellationToken

CancellationToken to cancel the operation
Returns
Type Description
Task<IActorRef>
Type Parameters
Name Description
T
| Improve this Doc View Source

ChildActorOfAsync<T>(CancellationToken)

Spawns an actor as a child of this test actor, and returns the child's ActorRef.

Declaration
public async Task<IActorRef> ChildActorOfAsync<T>(CancellationToken cancellationToken = default(CancellationToken))
    where T : ActorBase
Parameters
Type Name Description
CancellationToken cancellationToken

CancellationToken to cancel the operation
Returns
Type Description
Task<IActorRef>
Type Parameters
Name Description
T
| Improve this Doc View Source

CompareTo(Object)

Declaration
public int CompareTo(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Int32
| Improve this Doc View Source

CreateTestProbe(String)

N/A

Declaration
[Obsolete("Cannot create a TestProbe from a TestProbe", true)]
public override TestProbe CreateTestProbe(string name = null)
Parameters
Type Name Description
String name

N/A
Returns
Type Description
TestProbe

N/A
Overrides
Exceptions
Type Condition
NotSupportedException

This exception is thrown since a TestProbe cannot be created from a TestProbe.
| Improve this Doc View Source

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides
| Improve this Doc View Source

Forward(IActorRef)

Forwards the last received message to the specified actor as if the LastMessage was sent directly to the actor in the first place.

Declaration
public void Forward(IActorRef actor)
Parameters
Type Name Description
IActorRef actor

The actor to forward to.
| Improve this Doc View Source

Forward(IActorRef, Object)

Forwards a message to the specified actor. As sender the sender of the last message is used.

Declaration
public void Forward(IActorRef actor, object message)
Parameters
Type Name Description
IActorRef actor

The actor to forward to.
Object message

The message.
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides
| Improve this Doc View Source

Reply(Object)

Send message to the sender of the last received message.

Declaration
public void Reply(object message)
Parameters
Type Name Description
Object message

The message.
| Improve this Doc View Source

Send(IActorRef, Object)

Send message to an actor while using the probe as the sender. Replies will be available for inspection with all of TestKit's assertion methods.

Declaration
public void Send(IActorRef actor, object message)
Parameters
Type Name Description
IActorRef actor

The actor.
Object message

The message.
| Improve this Doc View Source

SendSystemMessage(ISystemMessage)

Sends a system message to the test probe

Declaration
public void SendSystemMessage(ISystemMessage message)
Parameters
Type Name Description
ISystemMessage message

The message to send
| Improve this Doc View Source

SendSystemMessage(ISystemMessage, IActorRef)

Sends a system message to the test probe

Declaration
public void SendSystemMessage(ISystemMessage message, IActorRef sender)
Parameters
Type Name Description
ISystemMessage message

The message to send
IActorRef sender

NOT USED.
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Explicit Interface Implementations

| Improve this Doc View Source

IActorRef.Path

Declaration
ActorPath IActorRef.Path { get; }
Returns
Type Description
ActorPath
| Improve this Doc View Source

ICanTell.Tell(Object, IActorRef)

Declaration
void ICanTell.Tell(object message, IActorRef sender)
Parameters
Type Name Description
Object message
IActorRef sender
| Improve this Doc View Source

ISurrogated.ToSurrogate(ActorSystem)

Declaration
ISurrogate ISurrogated.ToSurrogate(ActorSystem system)
Parameters
Type Name Description
ActorSystem system
Returns
Type Description
ISurrogate
| Improve this Doc View Source

IComparable<IActorRef>.CompareTo(IActorRef)

Declaration
int IComparable<IActorRef>.CompareTo(IActorRef other)
Parameters
Type Name Description
IActorRef other
Returns
Type Description
Int32
| Improve this Doc View Source

IEquatable<IActorRef>.Equals(IActorRef)

Declaration
bool IEquatable<IActorRef>.Equals(IActorRef other)
Parameters
Type Name Description
IActorRef other
Returns
Type Description
Boolean

Implements

Extension Methods