queue

Documentation

Index

• Variables
• type Item
• type ItemMetadata
• type Queue
  • func NewGenericQueue(ctx context.Context, numWorkers int, maxQueueSize int) (Queue, error)
• type QueueRepository
  • func NewQueueRepository(queue Queue) QueueRepository

Variables

var ErrAlreadyExists error = errors.New(`item already exists in the queue`)

var ErrItemNoID error = errors.New(`item must have ID`)

var ErrNotEnoughWorkers = errors.New("queue requires >= 1 workers")

var ErrNotFound error = errors.New(`item not found in the queue`)

var ErrQueueFull = errors.New("queue is full")

Types

type Item

type Item struct {
	ID       string
	Dag      []*dag.Node[dag.IOSpec]
	CID      string
	Metadata ItemMetadata
}

Item is an item in the QueueRepository

type ItemMetadata

type ItemMetadata struct {
	CreatedAt time.Time
	StartedAt time.Time
	EndedAt   time.Time
}

type Queue

type Queue interface {
	Enqueue(func(context.Context)) error // Adds item to the queue
	Start()                              // Starts the processing of the queue
	Stop()                               // Stops the processing of the queue
}

Queue encapsulates the Enqueue method that will be called by a dispatcher

func NewGenericQueue

func NewGenericQueue(ctx context.Context, numWorkers int, maxQueueSize int) (Queue, error)

type QueueRepository

type QueueRepository interface {
	List(context.Context) ([]*Item, error)
	Get(context.Context, string) (*Item, error)
	Create(context.Context, Item) error
}

QueueRepository is a store of Queue items

func NewQueueRepository

func NewQueueRepository(queue Queue) QueueRepository

NewQueueRepository creates a repository that returns queue information