messages

Documentation

Index

• Variables
• func New[T ~Message](key Key, attributes, meta any) *T
• func Random[T ~Message]() *T
• func RandomAttributes(attributes any)
• func RandomWithAttributes[T ~Message](attributes any, shouldRandomize bool) *T
• func RandomWithKey[T ~Message](key Key) *T
• type Key
  • func NewKey(key *KeyComponents) Key
• type KeyComponents
• type Message
• type Recipient
  • func NewRecipient(recipient *RecipientComponents) Recipient
• type RecipientComponents

Variables

var Status = struct {
	Queued, Succeeded, Failed, Done string
}{
	Queued:    "queued",
	Succeeded: "succeeded",
	Failed:    "failed",
	Done:      "done",
}

var Type = struct {
	Event, Command, Query, Response string
}{
	Event:    "event",
	Command:  "command",
	Query:    "query",
	Response: "response",
}

Functions

func New

func New[T ~Message](key Key, attributes, meta any) *T

func Random

func Random[T ~Message]() *T

func RandomAttributes

func RandomAttributes(attributes any)

func RandomWithAttributes

func RandomWithAttributes[T ~Message](attributes any, shouldRandomize bool) *T

func RandomWithKey

func RandomWithKey[T ~Message](key Key) *T

Types

type Key

type Key string

func NewKey

func NewKey(key *KeyComponents) Key

type KeyComponents

type KeyComponents struct {
	Organization, Service, Version, Type, Entity, Event, Command, Query, Response, Status string
}

Terminology:

• Organization = Context
• Service = Module
• Entity = Aggregate/Root

Nomenclature of a Key:

• organization.service.version.type.entity.event/command/query/response.status
• codexgo.user.1.event.user.created.succeeded

type Message

type Message = struct {
	ID         string
	OccurredOn string
	Key        Key
	Attributes any
	Meta       any
}

type Recipient

type Recipient string

func NewRecipient

func NewRecipient(recipient *RecipientComponents) Recipient

type RecipientComponents

type RecipientComponents struct {
	Service, Entity, Action, Event, Command, Status string
}

Terminology:

• Service = Module
• Entity = Aggregate/Root

Nomenclature of a Recipient:

• service.entity.action_on_event/command_status
• user.user.send_confirmation_on_created_succeeded