queue

Documentation

Index

• func Enqueue(id TaskID, data interface{}) error
• func New(rc *redis.Client, isDev bool, ex map[TaskID]TaskExecutor)
• func SetAsSubscriber()
• type Billing
  • func (b *Billing) Run(qt QueueTask) error
• type Email
  • func (e *Email) Run(qt QueueTask) error
• type Emailer
• type QueueTask
• type SendEmailParameter
• type TaskExecutor
• type TaskID

Functions

func Enqueue

func Enqueue(id TaskID, data interface{}) error

Enqueue adds a task to the queue.

func New

func New(rc *redis.Client, isDev bool, ex map[TaskID]TaskExecutor)

New initializes the queue tasks; intially called from cache package

func SetAsSubscriber

func SetAsSubscriber()

SetAsSubscriber makes this instance a Pub/Sub subscriber. Each message queued will be processed by this instance. Creates a subscriber to channel "q"

Types

type Billing

type Billing struct{}

func (*Billing) Run

func (b *Billing) Run(qt QueueTask) error

type Email

type Email struct {
	Send func(p SendEmailParameter) error
}

func (*Email) Run

func (e *Email) Run(qt QueueTask) error

type Emailer

type Emailer interface {
	Send(toEmail, toName, fromEmail, fromName, subject, body, replyTo string) error
}

type QueueTask

type QueueTask struct {
	ID      TaskID      `json:"id"`
	Data    interface{} `json:"data"`
	Created time.Time   `json:"created"`
}

QueueTask represents a queued task.

The Data field contains the necessary data for the task to execute properly.

type SendEmailParameter

type SendEmailParameter struct {
	From    string `json:"From"`
	To      string `json:"To"`
	Subject string `json:"Subject"`
	Body    string `json:"Body"`
}

type TaskExecutor

type TaskExecutor interface {
	Run(t QueueTask) error
}

TaskExecutor is an interface used to execute tasks based on their ID.

type TaskID

type TaskID int

TaskID are IDs representing a specific queued task. Each application task has an associated ID

const (
	// TaskEmail is for sending email.
	TaskEmail TaskID = iota
	// TaskCreateInvoice is for creating new Stripe invoice.
	TaskCreateInvoice
)