https://github.com/wind-c/bqueue
Time driven non-blocking and high-performance batch queue
https://github.com/wind-c/bqueue
batch callback-functions channel context golang high-performance non-blocking queue timer
Last synced: 10 months ago
JSON representation
Time driven non-blocking and high-performance batch queue
- Host: GitHub
- URL: https://github.com/wind-c/bqueue
- Owner: wind-c
- License: mit
- Created: 2023-01-28T13:37:55.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-28T14:42:50.000Z (about 3 years ago)
- Last Synced: 2025-04-15T12:13:45.626Z (10 months ago)
- Topics: batch, callback-functions, channel, context, golang, high-performance, non-blocking, queue, timer
- Language: Go
- Homepage:
- Size: 13.7 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
`bqueue` [](https://goreportcard.com/report/github.com/wind-c/bqueue) [](https://travis-ci.org/wind-c/bqueue) [](https://godoc.org/github.com/wind-c/bqueue)
=======
A high-performance batch queue to process items at time intervals or when a batching limit is met.
It is implemented using the go standard library and does not import any third-party libraries.
## Features
- **Non-blocking enqueue**
Queue up incoming items without blocking processing.
- **Dispatching by periodic time intervals**
Set a time interval and get batched items after time expires.
- **Dispatching as soon as a batch limit is met**
If a batch is filled before the time interval is up, dispatching is handled immediately.
- **Supports channel and callback**
You can read the OutQueue channel to get batch items, or you can use callback function. See Examples for details.
- **Plain old Go channels**
Implementation relies heavily on channels and is free of mutexes and other bookkeeping techniques.
## Install
```sh
$ go get -u github.com/wind-c/bqueue
```
## Sample Usage
Dispatch a batch at 1 second intervals or as soon as a batching limit of 64 items is met，
if the number of messages is large, increase MaxQueueSize.
See `examples/` for working code.
```go
import (
"fmt"
"log"
"time"
"github.com/wind-c/bqueue"
)
// initialize
b := bqueue.NewBatchQueue(&bqueue.Options{
Interval: time.Duration(1) * time.Second,
MaxBatchItems: 64,
MaxQueueSize: 1024,
})
defer b.Stop()
go b.Start()
// produce some messages
go func() {
for i:= 0; i < 100; i++ {
m := fmt.Sprintf("message #%d", i)
b.Enqueue(m)
}
}()
// consume the batch
for {
select {
case batch := <-b.OutQueue:
for _, item := range batch {
s := item.(string)
// do whatever.
log.Print(s)
}
}
}
```
## Contribute
Improvements, fixes, and feedback are welcome.
## Legal
MIT license.