work

type AckOptions struct {
	Namespace string
	QueueID   string
}

type BulkDequeuer interface {
	BulkDequeue(int64, *DequeueOptions) ([]*Job, error)
	BulkAck([]*Job, *AckOptions) error
}

type BulkEnqueuer interface {
	BulkEnqueue([]*Job, *EnqueueOptions) error
}

type DequeueFunc func(*DequeueOptions) (*Job, error)

type DequeueMiddleware func(DequeueFunc) DequeueFunc

type DequeueOptions struct {
	// Namespace is the namespace of a queue.
	Namespace string
	// QueueID is the id of a queue.
	QueueID string
	// At is the current time of the dequeuer.
	// Any job that is scheduled before this can be executed.
	At time.Time
	// After the job is dequeued, no other dequeuer can see this job for a while.
	// InvisibleSec controls how long this period is.
	InvisibleSec int64
}

type Dequeuer interface {
	Dequeue(*DequeueOptions) (*Job, error)
	Ack(*Job, *AckOptions) error
}

type EnqueueFunc func(*Job, *EnqueueOptions) error

type EnqueueMiddleware func(EnqueueFunc) EnqueueFunc

type EnqueueOptions struct {
	// Namespace is the namespace of a queue.
	Namespace string
	// QueueID is the id of a queue.
	QueueID string
}

type Enqueuer interface {
	Enqueue(*Job, *EnqueueOptions) error
}

type HandleFunc func(*Job, *DequeueOptions) error

type HandleMiddleware func(HandleFunc) HandleFunc

type Job struct {
	// ID is the unique id of a job.
	ID string `msgpack:"id"`
	// CreatedAt is set to the time when NewJob() is called.
	CreatedAt time.Time `msgpack:"created_at"`
	// UpdatedAt is when the job is last executed.
	// UpdatedAt is set to the time when NewJob() is called initially.
	UpdatedAt time.Time `msgpack:"updated_at"`
	// EnqueuedAt is when the job will be executed next.
	// EnqueuedAt is set to the time when NewJob() is called initially.
	EnqueuedAt time.Time `msgpack:"enqueued_at"`

	// Payload is raw bytes.
	Payload []byte `msgpack:"payload"`

	// If the job previously fails, Retries will be incremented.
	Retries int64 `msgpack:"retries"`
	// If the job previously fails, LastError will be populated with error string.
	LastError string `msgpack:"last_error"`
}

type JobOptions struct {
	WorkerOptions
	MaxExecutionTime time.Duration
	IdleWait         time.Duration
	NumGoroutines    int64

	DequeueMiddleware []DequeueMiddleware
	HandleMiddleware  []HandleMiddleware
}

type Metrics struct {
	Queue []*QueueMetrics
}

type MetricsExporter interface {
	GetQueueMetrics(*QueueMetricsOptions) (*QueueMetrics, error)
}

type Queue interface {
	Enqueuer
	Dequeuer
}

type QueueMetrics struct {
	Namespace string
	QueueID   string
	// Total number of jobs that can be executed right now.
	ReadyTotal int64
	// Total number of jobs that are scheduled to run in future.
	ScheduledTotal int64
}

type QueueMetricsOptions struct {
	Namespace string
	QueueID   string
	At        time.Time
}

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

type WorkerOptions struct {
	Namespace string
	Queue     Queue
	ErrorFunc func(error)
}