queue

Documentation

Index

• func Register(name string, d Driver) error
• type Driver
  • func Open(name string, cfg *config.QueueConfig) (Driver, error)
• type Job
  • func (j Job) HasFinished() bool
  • func (j Job) IsRunning() bool
  • func (j Job) Run() error
  • func (j Job) String() string
• type JobStats
• type Stats

Functions

func Register

func Register(name string, d Driver) error

Types

type Driver

type Driver interface {
	Open(*config.QueueConfig) (Driver, error)
	Enqueue(*Job) error
	List() ([]Job, error)
	Stats() (Stats, error)
	Err() <-chan error
	ListenAndConsume() error
}

func Open

func Open(name string, cfg *config.QueueConfig) (Driver, error)

type Job

type Job struct {
	// User space input
	ID          string   `json:"id"`
	Cmd         []string `json:"cmd"`
	MaxExecTime time.Duration

	// System level input
	EnqueuedAt    time.Time
	StartedAt     time.Time
	FinishedAt    time.Time
	RetryAttempts int64
	Error         string
}

func (Job) HasFinished

func (j Job) HasFinished() bool

func (Job) IsRunning

func (j Job) IsRunning() bool

func (Job) Run

func (j Job) Run() error

func (Job) String

func (j Job) String() string

type JobStats

type JobStats struct {
	JobID     string
	ProcessID int64
}

type Stats

type Stats struct {
	Pending   int64
	Running   int64
	Succeeded int64
	Failed    int64
	Retries   int64
}