envelope

type Envelope struct {
	// MessageID is a unique identifier for the message.
	MessageID string

	// CausationID is the ID of the message that was being handled when the
	// message identified by MessageID was produced.
	CausationID string

	// CorrelationID is the ID of the "root" message that entered the
	// application to cause the message identified by MessageID, either directly
	// or indirectly.
	CorrelationID string

	// Message is the application-defined message that the envelope represents.
	Message dogma.Message

	// CreatedAt is the time at which the message was created.
	CreatedAt time.Time

	// ScheduledFor holds the time for which a deadline message is scheduled.
	// Its value is undefined for commands and events.
	ScheduledFor time.Time

	// Origin describes the message handler that produced this message.
	// It is nil if the message was not produced by a handler.
	Origin *Origin

	// EventStreamID is the ID of the event stream to which this message
	// belongs, if it is a [dogma.Event].
	EventStreamID string

	// EventStreamOffset is the offset of the message within its event stream.
	EventStreamOffset uint64
}

type MessageIDGenerator struct {
	// contains filtered or unexported fields
}

type Origin struct {
	// Handler is the handler that produced this message.
	Handler config.Handler

	// HandlerType is the type of the handler that produced this message.
	HandlerType config.HandlerType

	// InstanceID is the ID of the aggregate or process instance that produced
	// this message.
	//
	// It is empty if HandlerType is neither [config.AggregateHandlerType] nor
	// [config.ProcessHandlerType].
	InstanceID string
}