https://github.com/vodolaz095/grq
Golang Redis Queue for persistent tasks should be used, when RabbitMQ is too much, and MQTT is not enough. And Beanstalkd is too old
https://github.com/vodolaz095/grq
go golang queue queue-manager queue-tasks queue-workers redis
Last synced: about 2 months ago
JSON representation
Golang Redis Queue for persistent tasks should be used, when RabbitMQ is too much, and MQTT is not enough. And Beanstalkd is too old
- Host: GitHub
- URL: https://github.com/vodolaz095/grq
- Owner: vodolaz095
- License: mit
- Created: 2020-12-12T16:04:09.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-12-20T20:40:19.000Z (4 months ago)
- Last Synced: 2025-01-16T19:06:09.288Z (3 months ago)
- Topics: go, golang, queue, queue-manager, queue-tasks, queue-workers, redis
- Language: Go
- Homepage:
- Size: 102 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# grq
[](https://github.com/vodolaz095/grq/actions/workflows/go.yml)
[](https://pkg.go.dev/github.com/vodolaz095/grq?tab=doc)
[](https://goreportcard.com/report/github.com/vodolaz095/grq)
Package grq implements persistent, thread and cross process safe task queue, that uses [redis](https://redis.io) as backend.
It should be used, when [RabbitMQ](https://www.rabbitmq.com/tutorials/tutorial-one-go.html) is too complicated,
and [MQTT](https://mqtt.org/getting-started/) is not enough (because it cannot cache messages), and [BeanStalkd](https://github.com/beanstalkd/beanstalkd)
is classic from [21 september of 2007 year](https://github.com/beanstalkd/beanstalkd/commit/50b5c5ed3fde33a18b90e93012ccd3e40c83fe38), that is hard to
find in many linux distros.
GRQ means `Golang Redis Queue`.
Advertisement
=======================
You can support development of this module by sending money directly to author
https://www.tinkoff.ru/rm/ostroumov.anatoliy2/4HFzm76801/
Simple task publisher
=======================
```go
package main
import (
queue "github.com/vodolaz095/grq"
"log"
"time"
)
type task struct {
Payload string
}
func (t task) String() string {
return t.Payload
}
func main() {
q, err := queue.New("test")
if err != nil {
log.Fatalf("%s : while connecting to redis", err)
}
for t := range time.NewTicker(time.Second).C {
err = q.Publish(task{Payload: t.Format(time.Stamp)})
if err != nil {
log.Fatalf("%s : while publishing task", err)
}
log.Println("Task published!")
}
}
```
Simple task consumer
================================
```go
package main
import (
queue "github.com/vodolaz095/grq"
"log"
"time"
)
func main() {
q, err := queue.New("test")
if err != nil {
log.Fatalf("%s : while connecting to redis", err)
}
q.SetHeartbeat(100 * time.Millisecond)
go func() {
log.Println("Preparing to stop consuming")
time.Sleep(time.Second)
log.Println("Stopping consuming...")
err := q.Cancel()
if err != nil {
log.Fatalf("%s : while closing redis task queue", err)
}
log.Println("Consuming stopped")
}()
tasks, err := q.Consume()
if err != nil {
log.Fatalf("%s : error consuming", err)
}
for t := range tasks {
log.Printf("Task with payload >>>%s<<< received", t)
}
log.Printf("Consumer \"test\" was Canceled")
}
```
Big example
========================
```go
package main
import (
"context"
"fmt"
"log"
"time"
"github.com/vodolaz095/grq"
)
func main() {
var redisConnectionString = grq.DefaultConnectionString
log.Printf("Dialing redis via %s", redisConnectionString)
// creating publisher and consumer, utilizing same `example` queue
publisher, err := grq.NewFromConnectionString("example", redisConnectionString)
if err != nil {
log.Fatalf("%s : while making publisher", err)
}
publisher.Context = context.Background() // by default, context is TODO, but you can change it, if required
consumer, err := grq.NewFromConnectionString("example", redisConnectionString)
if err != nil {
log.Fatalf("%s : while making consumer", err)
}
go func() {
// We start consumer here in different subroutine
consumer.SetHeartbeat(10 * time.Millisecond)
// if consumer did not received notifications for new tasks in example queue
// for 10 milliseconds, it will try to get new messages by itself
feed, err := consumer.Consume()
if err != nil {
log.Fatalf("%s : while making consumer", err)
}
for msg := range feed {
// reveal, how many messages are left in queue
n, err := consumer.Count()
if err != nil {
log.Fatalf("%s : while counting messages left", err)
}
// message consumed
log.Printf("Message received: %s. Messages left %v", msg, n)
}
}()
// we send tasks via publisher, anything that can be stringified by fmt.Sprint will do the trick
err = publisher.Publish("message 1")
if err != nil {
log.Fatalf("%s : while publishing message 1", err)
}
err = publisher.Publish(time.Now())
if err != nil {
log.Fatalf("%s : while publishing message 2", err)
}
err = publisher.Publish(fmt.Errorf("errors can be stringified, so it will do the trick"))
if err != nil {
log.Fatalf("%s : while publishing message 3", err)
}
// wait for consumer to process all
time.Sleep(time.Second)
// consumer is stopped, but we can still send messages to queue
err = consumer.Cancel()
if err != nil {
log.Fatalf("%s : canceling consumer", err)
}
// this message will be saved in queue, but not consumed
err = publisher.Publish(10)
if err != nil {
log.Fatalf("%s : while publishing message 3", err)
}
payload, found, err := publisher.GetTask()
if err != nil {
log.Fatalf("%s : while getting message 3 from queue", err)
}
if !found {
fmt.Println("where is our task? is it gone?")
}
fmt.Printf("Message 3 payload is %s\n", payload)
_, found, err = publisher.GetTask()
if err != nil {
log.Fatalf("%s : while getting nothing from queue", err)
}
if found {
fmt.Println("there is task present???")
} else {
fmt.Println("nothing left in the queue")
}
// publisher connection to redis database is closed
err = publisher.Close()
if err != nil {
log.Fatalf("%s : while closing publisher", err)
}
// consumer connection to redis database is closed
err = consumer.Close()
if err != nil {
log.Fatalf("%s : while closing consumer", err)
}
}
```
Protocol definition
================
Protocol is very simple, it can be used by your favourite redis client, including official `redis-cli`.
Publishing task to queue `taskQueue1` with payload `1419719` can be performed by redis command [lpush](https://redis.io/commands/lpush):
```shell
$ redis-cli lpush taskQueue1 1419719
```
If we want task to be executed first, it can be added to queue via [rpush](https://redis.io/commands/rpush):
```shell
$ redis-cli rpush taskQueue1 1419719
```
If we want to notify consumers that task is published, and we don't want to wait, when consumers internal timers triggers,
we can send notification that there is event in queue via [publish](https://redis.io/commands/publish) redis command.
```shell
$ redis-cli publish taskQueue1 anythingAsPayloadBecauseItIsIgnored
```
If we want to consume an event from a queue, we can use [lpop](https://redis.io/commands/lpop):
```shell
$ redis-cli lpop taskQueue1
```
and payload of 1419719 will be returned.
If we want to receive notification, when there are new messages in the queue, we can
[subscribe](https://redis.io/commands/subscribe) to this kind of messages easily:
```shell
$ redis-cli SUBSCRIBE "redisQueue/testHeartBeat"
```
License
=================
The MIT License (MIT)
Copyright (c) 2020 Ostroumov Anatolij
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.