Skip to content
/ gorqs Public

Go-based concurrent-safe library to start and stop a Queue with capabilities to asynchronously push jobs and execute them either into sync or async fashion. Along with capability to fetch their execution results.

License

Notifications You must be signed in to change notification settings

jeamon/gorqs

Repository files navigation

gorqs

Build Status godoc Go Report Card codecov GitHub go.mod Go version MIT License

gorqs means Go Runnable Queue Service. This is a multi-features go-based concurrent-safe library to queue & execute jobs and records their execution result. You can start the Queue service into synchronous or asynchronous mode. The mode defines wether each added job should be processed synchronously or asynchronously. Be aware that adding a job to the Queue system is always a non-blocking operation and returns the job id on success. Fetching a given job execution result removes that entry from local records cache.

Features

gorqs.New(gorqs.SyncMode | gorqs.TrackJobs) or gorqs.New(gorqs.AsyncMode | gorqs.TrackJobs) method provides a Queue object which implements the Queuer interface with below actions.

Action Description
Start(context.Context) error starts the jobs queue
Stop(context.Context) error stops the jobs queue
Push(context.Context, Runner) (int64, error) adds a job to the queue asynchronously
Fetch(context.Context, int64) error gets result execution of given job
IsRunning() bool provides queue service status
Clear() delete all jobs results records

An acceptable runnable job should implement the Runner interface defined as below :

type Runner interface {
	Run() error
}

Installation

Just import the gorqs library as external package to start using it into your project. There are some examples into the examples folder.

[Step 1] - Download the package

$ go get github.com/jeamon/gorqs

[Step 2] - Import the package into your project

$ import "github.com/jeamon/gorqs"

[Step 3] - Optional: Clone the library to run some examples

$ git clone https://github.com/jeamon/gorqs.git
$ cd gorqs
$ go run examples/sync-mode/example.go
$ go run examples/async-mode/example.go

Contact

Feel free to reach out to me before any action. Feel free to connect on Twitter or linkedin

About

Go-based concurrent-safe library to start and stop a Queue with capabilities to asynchronously push jobs and execute them either into sync or async fashion. Along with capability to fetch their execution results.

Topics

Resources

License

Stars

Watchers

Forks