queue

Documentation

Index

• type Queue
  • func NewQueue(ctx context.Context, name string, ds datastore.Datastore) (*Queue, error)
  • func (q *Queue) Close() error
  • func (q *Queue) Dequeue() <-chan cid.Cid
  • func (q *Queue) Enqueue(cid cid.Cid) error

Types

type Queue

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

Queue provides a best-effort durability, FIFO interface to the datastore for storing cids

Best-effort durability just means that cids in the process of being provided when a crash or shutdown occurs may be in the queue when the node is brought back online depending on whether the underlying datastore has synchronous or asynchronous writes.

func NewQueue

func NewQueue(ctx context.Context, name string, ds datastore.Datastore) (*Queue, error)

NewQueue creates a queue for cids

func (*Queue) Close

func (q *Queue) Close() error

Close stops the queue

func (*Queue) Dequeue

func (q *Queue) Dequeue() <-chan cid.Cid

Dequeue returns a channel that if listened to will remove entries from the queue

func (*Queue) Enqueue

func (q *Queue) Enqueue(cid cid.Cid) error

Enqueue puts a cid in the queue