Skip to content

Envelope

struct

Namespace: Orleans.Durable.Messaging

Contains a command identity, payload, subject, optional application headers, and an optional delivery time.
[Orleans.GenerateSerializer]
[Orleans.Alias(Orleans.Durable.Messaging.Envelope)]
public readonly struct Envelope

Remarks

Message identity and payload are required; an empty payload is valid. Raw protocols can omit subject and headers. Prepare the payload and headers before publishing a message and keep them unchanged afterward. Struct assignment shares these objects; ordinary Orleans deep copying and deserialization produce independent payload arrays, header dictionaries, and header value arrays.

Properties

  • DeliverAtGets the optional earliest time at which the receiving inbox processes the message.
  • HeadersGets optional application-defined named byte-array headers.
  • MessageIdGets the exact application-defined command identity within the receiving inbox.
  • PayloadGets the required application payload bytes, including an empty payload.
  • SubjectGets the optional, nonempty ordinal application protocol subject.