Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var (
ErrNilValue = errors.New("Nil value not allowed")
)
View Source
var (
ValidQueueName = regexp.MustCompile(`\A[a-zA-Z0-9._-]+\z`)
)
Functions ¶
Types ¶
type Queue ¶
type Queue interface {
Name() string
Size() uint64
Add(job *client.Job) error
Push(priority uint8, data []byte) error
Pop() ([]byte, error)
BPop(context.Context) ([]byte, error)
Clear() (uint64, error)
Each(func(index int, data []byte) error) error
Page(start int64, count int64, fn func(index int, data []byte) error) error
Delete(keys [][]byte) error
}
type SortedEntry ¶ added in v1.5.0
type SortedSet ¶
type SortedSet interface {
Name() string
Size() uint64
Clear() error
Add(job *client.Job) error
AddElement(timestamp string, jid string, payload []byte) error
Get(key []byte) (SortedEntry, error)
Page(start int, count int, fn func(index int, e SortedEntry) error) (int, error)
Each(fn func(idx int, e SortedEntry) error) error
// bool is whether or not the element was actually removed from the sset.
// the scheduler and other things can be operating on the sset concurrently
// so we need to be careful about the data changing under us.
Remove(key []byte) (bool, error)
RemoveElement(timestamp string, jid string) (bool, error)
RemoveBefore(timestamp string) ([][]byte, error)
// Move the given key from this SortedSet to the given
// SortedSet atomically. The given func may mutate the payload and
// return a new tstamp.
MoveTo(sset SortedSet, entry SortedEntry, newtime time.Time) error
}
type Store ¶
type Store interface {
Close() error
Retries() SortedSet
Scheduled() SortedSet
Working() SortedSet
Dead() SortedSet
GetQueue(string) (Queue, error)
EachQueue(func(Queue))
Stats() map[string]string
EnqueueAll(SortedSet) error
EnqueueFrom(SortedSet, []byte) error
History(days int, fn func(day string, procCnt uint64, failCnt uint64)) error
Success() error
Failure() error
TotalProcessed() uint64
TotalFailures() uint64
// Clear the database of all job data.
// Equivalent to Redis's FLUSHDB
Flush() error
Raw() KV
}
Click to show internal directories.
Click to hide internal directories.