Struct Envelope

Envelope class, represents a message and the sender of the message.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Akka.Actor

Assembly: Akka.dll

Syntax

public readonly struct Envelope

Constructors

Envelope(object, IActorRef)

Initializes a new instance of the Envelope struct.

Declaration

public Envelope(object message, IActorRef sender)

Parameters

Type	Name	Description
object	message	The message being sent.
IActorRef	sender	The actor who sent the message.

Envelope(object, IActorRef, ActorSystem)

Initializes a new instance of the Envelope struct.

Declaration

public Envelope(object message, IActorRef sender, ActorSystem system)

Parameters

Type	Name	Description
object	message	The message being sent.
IActorRef	sender	The actor who sent the message.
ActorSystem	system	The current actor system.

Exceptions

Type	Condition
ArgumentNullException	This exception is thrown if the given message is undefined.

Properties

Message

Gets or sets the message.

Declaration

public object Message { get; }

Property Value

Type	Description
object	The message.

Sender

Gets or sets the sender.

Declaration

public IActorRef Sender { get; }

Property Value

Type	Description
IActorRef	The sender.

Methods

ToString()

Converts the Envelope to a string representation.

Declaration

public override string ToString()

Returns

Type	Description
string	A string.

Overrides

ValueType.ToString()

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)