Class PoisonPill

Sending a PoisonPill to an actor will stop the actor when the message is processed. PoisonPill is enqueued as ordinary messages and will be handled after messages that were already queued in the mailbox.

See also Kill which causes the actor to throw an ActorKilledException when it processes the message, which gets handled using the normal supervisor mechanism, and Stop(IActorRef) which causes the actor to stop without processing any more messages.

Inheritance

object

PoisonPill

Implements

IAutoReceivedMessage

IPossiblyHarmful

IDeadLetterSuppression

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Akka.Actor

Assembly: Akka.dll

Syntax

public sealed class PoisonPill : IAutoReceivedMessage, IPossiblyHarmful, IDeadLetterSuppression

Properties

Instance

The singleton instance of PoisonPill.

Declaration

public static PoisonPill Instance { get; }

Property Value

Type	Description
PoisonPill

Methods

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

Implements

IAutoReceivedMessage

IPossiblyHarmful

IDeadLetterSuppression

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)