message

Documentation

Index

• func GetQueueParts(queue string) (prefix string, suffix string)
• func GetQueuePrefix(queue string) string
• type Message
  • func (q *Message) GetQueueParts() (prefix string, suffix string)

Functions

func GetQueueParts

func GetQueueParts(queue string) (prefix string, suffix string)

func GetQueuePrefix

func GetQueuePrefix(queue string) string

Types

type Message

type Message struct {
	ID string `json:"id" bson:"id"`

	// Description of the message, this should be used as a message's human readable id.
	Description string

	// Queue is the identifier of this message. Commonly used as channel.
	Queue string `json:"queue" bson:"queue"`

	// ExpiryDate is the date where this message is not valid anymore.
	ExpiryDate time.Time `json:"expiry_date,omitempty" bson:"expiry_date,omitempty"`

	// To ignore Expire Date and be eternal
	Timeless bool `json:"timeless" bson:"timeless"`

	// Metadata is a map of string to be used as a key-value store.
	// It is a simple way to store data that is not part of the message payload.
	Metadata map[string]string `json:"metadata,omitempty" bson:"metadata,omitempty"`

	// Payload is a structured data map that can be used to store any kind of data.
	// Is responsibility of the caller to know how to encode/decode to a useful format for its purpose.
	// It is recommended to use this field instead of Data.
	Payload map[string]*anypb.Any `json:"payload,omitempty" bson:"payload,omitempty"`

	// StringPayload is a field to populate with any custom data to store in the message.
	// This is represented as a string and is responsibility of the caller
	// to know how to encode/decode to a useful format for its purpose.
	StringPayload string `json:"string_payload,omitempty" bson:"string_payload,omitempty"`

	// Time in milliseconds that this message will be locked before returning to the message pool.
	LockMs int64 `json:"lock_ms" bson:"lock_ms"`

	// The internal storage id for this message
	// For MongoDB storage it is the _id field as primitive.ObjectID
	// For Memory storage it is an int64
	InternalId interface{} `json:"_id,omitempty" bson:"_id,omitempty"`

	// Score defines the score priority of this message.
	Score float64 `json:"score" bson:"score"`

	// Represents the result from the last time this message has been processed successfully (acknowledged).
	LastUsage         *time.Time `json:"last_usage,omitempty" bson:"last_usage,omitempty"`
	Breakpoint        string     `json:"breakpoint" bson:"breakpoint"`
	LastScoreSubtract float64    `json:"last_score_subtract" bson:"last_score_subtract"`

	// Statistical data about the 'performance' of this message.
	TotalScoreSubtract float64 `json:"total_score_subtract" bson:"total_score_subtract"`
	UsageCount         int64   `json:"usage_count" bson:"usage_count"`

	// Poppulated with the first part of the queue name if it contains the :: separator or the queue name otherwise.
	QueuePrefix string `json:"queue_prefix" bson:"queue_prefix"`

	// Poppulated with the second part of the queue name if it contains the :: separator.
	QueueSuffix string `json:"queue_suffix" bson:"queue_suffix"`
}

Message contains all data related to a single message. Including telemetry data.

func (*Message) GetQueueParts

func (q *Message) GetQueueParts() (prefix string, suffix string)