queues

Documentation

Index

• type FailedMessage
• type Queue
• type Queues
  • func New() (Queues, error)
• type ReceivedMessage

Types

type FailedMessage

type FailedMessage struct {
	// Message - The message that failed to queue
	Message map[string]interface{}
	// Reason - Reason for the failure
	Reason string
}

type Queue

type Queue interface {
	// Name - The name of the queue
	Name() string
	// Enqueue - Push a number of messages to a queue
	Enqueue(context.Context, []map[string]interface{}) ([]*FailedMessage, error)
	// Dequeue - Retrieve messages from a queue to a maximum of the given depth
	Dequeue(context.Context, int) ([]ReceivedMessage, error)
}

Queue is a resource for async enqueueing/dequeueing of messages.

type Queues

type Queues interface {
	Queue(string) Queue
}

Queues - Idiomatic interface for the nitric queue service

func New

func New() (Queues, error)

New - Construct a new Queueing Client with default options

type ReceivedMessage

type ReceivedMessage interface {
	// Queue - Returns the name of the queue this message was retrieved from
	Queue() string
	// Message - Returns the Message data contained in this Received Message instance
	Message() map[string]interface{}
	// Complete - Completes the message removing it from the queue
	Complete(context.Context) error
}