# README
OrcaQ | A Lightweight Durable Worker Queue
Many thanks to the Original Author (@chiefnoah) for this awesome project!
View it here: https://github.com/chiefnoah/goalpost
TODO:
-
convert queue to use nutsdb in favor of boltdb
-
add 'schedule' job feature, to schedule jobs into the future
-
add 'repeat' job feature, to repeat the job X number of times
-
add all required methods for managing the job queue
-
add metadata/tags property to jobs
-
add human friendly label to a job
-
update test to reflect changes to package
-
add audit log to job and task state
# Functions
DecodeJob decodes a gob encoded byte array into a Job struct and returns a pointer to it.
Init creates a connection to the internal database and initializes the Queue typefilepath must be a valid path to a file.
NewRecoverableWorkerError creates a new RecoverableWorkerError.
# Structs
An AuditMessage represents something that has happened.
A Job is one or more Task that represents work to be done by the Agent.
Queue represents a queue.
RecoverableWorkerError defines an error that a worker DoWork funccan return that indicates the message should be retried.
A Task is a single unit of work.
# Interfaces
Worker represents a worker for handling Jobs.