queue

Documentation

Index

• type Message
• type ReadWriter
• type Reader
• type Redis
  • func NewRedis(endpoint, password string, db, retries int) *Redis
  • func (r *Redis) Pop(channel string) (string, error)
  • func (r *Redis) Push(req *apiv1.NotificationRequest, channel string) error
• type Writer

Types

type Message

type Message struct {
	// Message is the message body
	Message string

	// Recepients is the list of recepients
	Recepients []string

	// Subject is the message subject
	Subject *string

	// Template is the message template
	Template *template.Template
}

Message is a message for a channel

type ReadWriter

type ReadWriter interface {
	Reader
	Writer
}

ReadWriter is used to read and write messages to a queue

type Reader

type Reader interface {
	// Pop returns and removes the next message from the queue
	Pop(channel string) (string, error)
}

Reader is used to read messages from a queue

type Redis

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

Redis is used to push and pop messages

func NewRedis

func NewRedis(endpoint, password string, db, retries int) *Redis

NewRedis creates a new Redis

func (*Redis) Pop

func (r *Redis) Pop(channel string) (string, error)

Pop returns and removes the next message from the queue

func (*Redis) Push

func (r *Redis) Push(req *apiv1.NotificationRequest, channel string) error

Push adds a message to the queue

type Writer

type Writer interface {
	// Push adds a message to the queue
	Push(req *apiv1.NotificationRequest, channel string) error
}

Writer is used to write messages to a queue