storage

Documentation

Index

• Constants
• type Msg
• type Retries
• type RetryJobStats
• type Stats
• type StorageError
  • func (e StorageError) Error() string
• type Store
  • func NewRedisStore(namespace string, client *redis.Client) Store

Constants

const (
	RetryKey         = "goretry"
	ScheduledJobsKey = "schedule"
)

TODO(wtlangford): Check if the value of these keys are Sidekiq-compatible

const NoMessage = StorageError("no message")

Types

type Msg

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

type Retries

type Retries struct {
	TotalRetryCount int64
	RetryJobs       []RetryJobStats
}

type RetryJobStats

type RetryJobStats struct {
	Class        string
	ErrorMessage string
	FailedAt     string
	JobID        string
	Queue        string
	RetryCount   int64
}

type Stats

type Stats struct {
	Processed  int64
	Failed     int64
	RetryCount int64
	Enqueued   map[string]int64
}

type StorageError

type StorageError string

func (StorageError) Error

func (e StorageError) Error() string

type Store

type Store interface {

	// General queue operations
	CreateQueue(queue string) error
	ListMessages(queue string) ([]string, error)
	AcknowledgeMessage(queue string, message string) error
	EnqueueMessage(queue string, priority float64, message string) error
	EnqueueMessageNow(queue string, message string) error
	DequeueMessage(queue string, inprogressQueue string, timeout time.Duration) (string, error)

	// Special purpose queue operations
	EnqueueScheduledMessage(priority float64, message string) error
	DequeueScheduledMessage(priority float64) (string, error)

	EnqueueRetriedMessage(priority float64, message string) error
	DequeueRetriedMessage(priority float64) (string, error)

	// Stats
	IncrementStats(metric string) error
	GetAllStats(queues []string) (*Stats, error)

	// Retries
	GetAllRetries() (*Retries, error)
}

func NewRedisStore

func NewRedisStore(namespace string, client *redis.Client) Store