job

Documentation

Overview

Package job implements the schedulable message(job) underlying storage.

Package job implements the schedulable message(job) underlying storage.

Index

• Variables
• type JobItem
  • func (this JobItem) PayloadString(limit int) string
  • func (this JobItem) String() string
• type JobStore

Variables

var (
	ErrNothingDeleted = errors.New("nothing deleted")
)

Types

type JobItem

type JobItem struct {
	JobId   int64
	Payload []byte
	Ctime   int64
	DueTime int64
}

func (JobItem) PayloadString

func (this JobItem) PayloadString(limit int) string

func (JobItem) String

func (this JobItem) String() string

type JobStore

type JobStore interface {

	// Name returns the underlying storage name.
	Name() string

	Start() error
	Stop()

	// CreateJobQueue creates a storage container where jobs will persist.
	CreateJobQueue(shardId int, appid, topic string) (err error)

	// Add pubs a schedulable message(job) synchronously.
	Add(appid, topic string, payload []byte, due int64) (jobId string, err error)

	// Delete removes a job by jobId.
	Delete(appid, topic, jobId string) (err error)
}

JobStore is the backend storage layer for jobs(schedulable message).

var Default JobStore