queue

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

type DatabaseOptions struct {
	// Table holds pending jobs (default "jobs").
	Table string
	// FailedTable holds failed jobs (default "failed_jobs").
	FailedTable string
	// Grace is added to a job's timeout before an abandoned reservation is
	// taken over (default 1 minute).
	Grace time.Duration
	// Now is the clock (default time.Now); tests set it.
	Now func() time.Time
}

type Driver interface {
	// Push stores m; it becomes available at m.AvailableAt.
	Push(ctx context.Context, m *Message) error
	// Pop reserves the next available message on one of queues (in
	// order), or returns nil when there is none.
	Pop(ctx context.Context, queues []string) (*Message, error)
	// Ack deletes a processed message.
	Ack(ctx context.Context, m *Message) error
	// Release makes m available again at m.AvailableAt (a retry).
	Release(ctx context.Context, m *Message) error
	// Fail moves m to the failed jobs.
	Fail(ctx context.Context, m *Message) error
}

type FailedJob struct {
	Message

	FailedAt time.Time `json:"failed_at"`
}

type FailedStore interface {
	// Failed lists failed jobs, newest first.
	Failed(ctx context.Context) ([]FailedJob, error)
	// Retry re-queues failed jobs (all when ids is empty).
	Retry(ctx context.Context, ids ...string) (int, error)
	// Forget deletes failed jobs (all when ids is empty).
	Forget(ctx context.Context, ids ...string) (int, error)
}

type Fake struct {
	*Memory
	// contains filtered or unexported fields
}

type Inline interface {
	Inline() bool
}

type Job interface {
	Kind() string
}

type JobEvent struct {
	ID       string
	Kind     string
	Queue    string
	Status   JobStatus
	Attempt  int
	Duration time.Duration
	Err      error
}

type JobStatus string

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

type Message struct {
	ID          string          `json:"id"`
	Kind        string          `json:"kind"`
	Queue       string          `json:"queue"`
	Payload     json.RawMessage `json:"payload"`
	Attempts    int             `json:"attempts"`
	MaxRetries  int             `json:"max_retries"`
	Timeout     time.Duration   `json:"timeout"`
	AvailableAt time.Time       `json:"available_at"`
	CreatedAt   time.Time       `json:"created_at"`
	// LastError is set when the job failed.
	LastError string `json:"last_error,omitempty"`
}

type Observer interface {
	ObserveJob(ctx context.Context, e JobEvent)
}

type Option func(*options)

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

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

type Sync struct{}

type TxPusher interface {
	PushTx(ctx context.Context, ex database.Executor, m *Message) error
}

type WorkOptions struct {
	// Queues are polled in priority order (default ["default"]).
	Queues []string
	// Concurrency is the number of parallel workers (default 1).
	Concurrency int
	// Sleep is the wait when no job is available (default 1s).
	Sleep time.Duration
	// MaxJobs stops after processing this many jobs (0 = no limit), e.g.
	// for "queue:work --once".
	MaxJobs int
	// StopWhenEmpty returns when no job is available.
	StopWhenEmpty bool
}