queues

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

type Queue interface {
	// Allow requests the given permissions to the queue.
	Allow(permission QueuePermission, permissions ...QueuePermission) *QueueClient
}

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

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

type QueuePermission string

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
}