docs: Add redis, nats and NSQ example

Signed-off-by: Bo-Yi Wu <[email protected]>

Author: appleboy

README.md

@@ -143,3 +143,256 @@ func main() {
   }
 }
 ```
+
+## Using NSQ as Queue
+
+See the [NSQ documentation](https://github.com/golang-queue/nsq).
+
+```go
+package main
+
+import (
+  "context"
+  "encoding/json"
+  "fmt"
+  "log"
+  "time"
+
+  "github.com/golang-queue/nsq"
+  "github.com/golang-queue/queue"
+)
+
+type job struct {
+  Message string
+}
+
+func (j *job) Bytes() []byte {
+  b, err := json.Marshal(j)
+  if err != nil {
+    panic(err)
+  }
+  return b
+}
+
+func main() {
+  taskN := 100
+  rets := make(chan string, taskN)
+
+  // define the worker
+  w := nsq.NewWorker(
+    nsq.WithAddr("127.0.0.1:4150"),
+    nsq.WithTopic("example"),
+    nsq.WithChannel("foobar"),
+    // concurrent job number
+    nsq.WithMaxInFlight(10),
+    nsq.WithRunFunc(func(ctx context.Context, m queue.QueuedMessage) error {
+      v, ok := m.(*job)
+      if !ok {
+        if err := json.Unmarshal(m.Bytes(), &v); err != nil {
+          return err
+        }
+      }
+
+      rets <- v.Message
+      return nil
+    }),
+  )
+
+  // define the queue
+  q, err := queue.NewQueue(
+    queue.WithWorkerCount(10),
+    queue.WithWorker(w),
+  )
+  if err != nil {
+    log.Fatal(err)
+  }
+
+  // start the five worker
+  q.Start()
+
+  // assign tasks in queue
+  for i := 0; i < taskN; i++ {
+    go func(i int) {
+      q.Queue(&job{
+        Message: fmt.Sprintf("handle the job: %d", i+1),
+      })
+    }(i)
+  }
+
+  // wait until all tasks done
+  for i := 0; i < taskN; i++ {
+    fmt.Println("message:", <-rets)
+    time.Sleep(50 * time.Millisecond)
+  }
+
+  // shutdown the service and notify all the worker
+  q.Release()
+}
+```
+
+## Using NATs as Queue
+
+See the [NATs documentation](https://github.com/golang-queue/nats)
+
+```go
+package main
+
+import (
+  "context"
+  "encoding/json"
+  "fmt"
+  "log"
+  "time"
+
+  "github.com/golang-queue/nats"
+  "github.com/golang-queue/queue"
+)
+
+type job struct {
+  Message string
+}
+
+func (j *job) Bytes() []byte {
+  b, err := json.Marshal(j)
+  if err != nil {
+    panic(err)
+  }
+  return b
+}
+
+func main() {
+  taskN := 100
+  rets := make(chan string, taskN)
+
+  // define the worker
+  w := nats.NewWorker(
+    nats.WithAddr("127.0.0.1:4222"),
+    nats.WithSubj("example"),
+    nats.WithQueue("foobar"),
+    nats.WithRunFunc(func(ctx context.Context, m queue.QueuedMessage) error {
+      v, ok := m.(*job)
+      if !ok {
+        if err := json.Unmarshal(m.Bytes(), &v); err != nil {
+          return err
+        }
+      }
+
+      rets <- v.Message
+      return nil
+    }),
+  )
+
+  // define the queue
+  q, err := queue.NewQueue(
+    queue.WithWorkerCount(10),
+    queue.WithWorker(w),
+  )
+  if err != nil {
+    log.Fatal(err)
+  }
+
+  // start the five worker
+  q.Start()
+
+  // assign tasks in queue
+  for i := 0; i < taskN; i++ {
+    go func(i int) {
+      q.Queue(&job{
+        Message: fmt.Sprintf("handle the job: %d", i+1),
+      })
+    }(i)
+  }
+
+  // wait until all tasks done
+  for i := 0; i < taskN; i++ {
+    fmt.Println("message:", <-rets)
+    time.Sleep(50 * time.Millisecond)
+  }
+
+  // shutdown the service and notify all the worker
+  q.Release()
+}
+```
+
+## Using Redis(Pub/Sub) as Queue
+
+See the [redis documentation](https://github.com/golang-queue/redisdb)
+
+```go
+package main
+
+import (
+  "context"
+  "encoding/json"
+  "fmt"
+  "log"
+  "time"
+
+  "github.com/golang-queue/queue"
+  "github.com/golang-queue/redisdb"
+)
+
+type job struct {
+  Message string
+}
+
+func (j *job) Bytes() []byte {
+  b, err := json.Marshal(j)
+  if err != nil {
+    panic(err)
+  }
+  return b
+}
+
+func main() {
+  taskN := 100
+  rets := make(chan string, taskN)
+
+  // define the worker
+  w := redisdb.NewWorker(
+    redisdb.WithAddr("127.0.0.1:6379"),
+    redisdb.WithChannel("foobar"),
+    redisdb.WithRunFunc(func(ctx context.Context, m queue.QueuedMessage) error {
+      v, ok := m.(*job)
+      if !ok {
+        if err := json.Unmarshal(m.Bytes(), &v); err != nil {
+          return err
+        }
+      }
+
+      rets <- v.Message
+      return nil
+    }),
+  )
+
+  // define the queue
+  q, err := queue.NewQueue(
+    queue.WithWorkerCount(10),
+    queue.WithWorker(w),
+  )
+  if err != nil {
+    log.Fatal(err)
+  }
+
+  // start the five worker
+  q.Start()
+
+  // assign tasks in queue
+  for i := 0; i < taskN; i++ {
+    go func(i int) {
+      q.Queue(&job{
+        Message: fmt.Sprintf("handle the job: %d", i+1),
+      })
+    }(i)
+  }
+
+  // wait until all tasks done
+  for i := 0; i < taskN; i++ {
+    fmt.Println("message:", <-rets)
+    time.Sleep(50 * time.Millisecond)
+  }
+
+  // shutdown the service and notify all the worker
+  q.Release()
+}
+```