PoisonPill Class

PoisonPill Class

Sending a PoisonPill to an 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(ActorRef) which causes the actor to stop without processing any more messages.

Inheritance Hierarchy

SystemObject
Akka.ActorPoisonPill

Namespace: Akka.Actor
Assembly: Akka (in Akka.dll) Version: 0.8.0.0 (0.8.0.0)

Syntax

C++

Copy

public sealed class PoisonPill : AutoReceivedMessage, 
	NoSerializationVerificationNeeded

Public NotInheritable Class PoisonPill
	Implements AutoReceivedMessage, NoSerializationVerificationNeeded

public ref class PoisonPill sealed : AutoReceivedMessage, 
	NoSerializationVerificationNeeded

[<SealedAttribute>]
type PoisonPill =  
    class
        interface AutoReceivedMessage
        interface NoSerializationVerificationNeeded
    end

The PoisonPill type exposes the following members.

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	AsInstanceOfT	(Defined by Extensions.)
	Match	Matches the specified target. (Defined by PatternMatch.)

Top

Properties

	Name	Description
	Instance

Top

Reference

Akka.Actor Namespace