orcaq

type AuditMessage struct {
	Message string
	Time    time.Time
}

type Job struct {
	Label    string          // human friendly label
	Status   string          // current status of the job. Will always be overwritten.
	ID       []byte          // this will be a UUID, stored as bytes. Will always be overwritten.
	Tasks    []*Task         // the actual tasks that make up this job.
	Deadline time.Time       // Deadline is the time by when the job should be executed. Default is now.
	AuditLog []*AuditMessage // the audit log will contain the full history of the job
}

type Queue struct {
	//ID is a unique identifier for a Queue
	ID string

	//PollRate the duration to Sleep each worker before checking the queue for jobs again
	//queue for jobs again.
	//Default: 500 milliseconds
	PollRate time.Duration
	// contains filtered or unexported fields
}

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

type Task struct {
	ID         string          // this will be a UUID that is generated at runtime.
	Label      string          // optional human friendly label
	Status     string          // current status of the task
	RetryCount int             // number of times this task has been retried
	RetryMax   int             // number of times this task can be retried before failing hard.
	Cmd        string          // the command that is to be ran
	Arg        []string        // any arguments that the command requires
	Stdout     bytes.Buffer    // results of the cmd that would be sent to stdout
	Stderr     bytes.Buffer    // results of the cmd that would be sent to stderr
	ExitCode   int             // exit code of the task
	AuditLog   []*AuditMessage // the audit log will contain all events that are associated with this task
}

type Worker interface {
	//Start is called when a worker picks up a job from the queue
	//Context can be used for cancelling jobs early when Close
	//is called on the Queue
	Start(context.Context, *Job) error
	//ID is a semi-unique identifier for a worker.
	ID() string
}