queue

type AdvanceEpochFunc func(ctx context.Context, txn transaction.Txn) error

type ProcessKeyValueFunc func(ctx context.Context, txn transaction.Txn, key, value []byte) error

type Queuer interface {
	// Enqueue submits a key, value pair for processing.
	// Duplicate key, value pairs will be processed in the order received by
	// the queue. Mutations SHOULD explicitly reference any data they modify
	// to be robust across epoch updates.
	Enqueue(key, value []byte) error

	// Commit all enqueued items to the sparse merkle tree.
	AdvanceEpoch() error

	// StartReceiving starts receiving queue enqueued items.
	StartReceiving(processFunc ProcessKeyValueFunc, advanceFunc AdvanceEpochFunc) (Receiver, error)
}

type Receiver interface {
	// Close stops the receiver from receiving items from the queue.
	Close()
}