Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/c2nes/qrono
Qrono time-ordered queue server
https://github.com/c2nes/qrono
at-least-once java queue redis rust service time-series workqueue
Last synced: 2 months ago
JSON representation
Qrono time-ordered queue server
- Host: GitHub
- URL: https://github.com/c2nes/qrono
- Owner: c2nes
- License: agpl-3.0
- Created: 2020-09-25T15:23:11.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-12-02T01:51:47.000Z (about 2 years ago)
- Last Synced: 2023-03-12T06:38:06.198Z (almost 2 years ago)
- Topics: at-least-once, java, queue, redis, rust, service, time-series, workqueue
- Language: Rust
- Homepage:
- Size: 814 KB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Qrono
[](https://github.com/c2nes/qrono/actions?query=workflow%3Abuild)
Qrono is a time-ordered queue server.
> :warning: Qrono is a hobby project. **It is not production ready.**
Values in a Qrono queue are ordered by their _deadline_ and can only be dequeued once their deadline has passed. A deadline can be specified when enqueuing or requeuing a value and defaults to the current time. Values with equal deadlines are processed in FIFO order.
Qrono provides multiple interfaces. In addition to standard HTTP and gRPC interfaces, Qrono provides a Redis-compatible [RESP](https://redis.io/topics/protocol) interface allowing `redis-cli` and many existing Redis client libraries to be used.
## Quick Start
Dev releases are available on [Docker Hub](https://hub.docker.com/r/qrono/qrono),
``` shellsession
# Start Qrono and forward the RESP (Redis protocol) port
$ docker run --rm -d -p 16379:16379 --name qrono qrono/qrono:dev
# Test that server is up and responding
$ redis-cli -p 16379 PING
PONG
# Normal enqueue. Uses "now" as the default deadline providing
# traditional FIFO queue semantics.
$ redis-cli -p 16379 ENQUEUE my-queue my-value
1) (integer) 11000001
2) (integer) 1610207507966
# Dequeue next value from the queue. The entry is now in the "working"
# state and must be explicitly released or requeued by ID.
$ redis-cli -p 16379 DEQUEUE my-queue
1) 1) (integer) 11000001
2) (integer) 1610207507966
3) (integer) 1610207507966
4) (integer) 0
5) (integer) 1
6) "my-value"
# The queue has 0 pending and 1 dequeued (i.e. "working") item.
$ redis-cli -p 16379 STAT my-queue
1) (integer) 0
2) (integer) 1
# Release the previously dequeued value.
$ redis-cli -p 16379 RELEASE my-queue 11000001
OK
# The queue is now empty.
$ redis-cli -p 16379 STAT my-queue
1) (integer) 0
2) (integer) 0
# Enqueue a value 10 seconds in the future
$ redis-cli -p 16379 ENQUEUE my-queue my-future-value DELAY 10000
1) (integer) 11000002
2) (integer) 1610207677000
# Value will not be immediatatley available for dequeue
$ redis-cli -p 16379 DEQUEUE my-queue
(nil)
# With a timeout we can perform a blocking dequeue.
$ time redis-cli -p 16379 DEQUEUE my-queue TIMEOUT 30000
1) 1) (integer) 11000002
2) (integer) 1610207677000
3) (integer) 1610207667438
4) (integer) 0
5) (integer) 1
6) "my-future-value"
real 0m8.692s
user 0m0.005s
sys 0m0.005s
```
## Queue operations
### Enqueue
```
ENQUEUE queue value [DEADLINE milliseconds-timestamp | DELAY milliseconds]
(integer) id
(integer) deadline
```
Add a `value` to the `queue` with the given deadline which defaults to now. After being enqueued the value is considered _pending_.
### Dequeue
```
DEQUEUE queue [COUNT n] [TIMEOUT milliseconds]
(array)
(integer) id
(integer) deadline
(integer) enqueue-time
(integer) requeue-time
(integer) dequeue-count
(bulk) value
```
Dequeue the next _n_ pending value from the `queue`. With a timeout, the operation is blocking and returns once the timeout expires or at least one item becomes available. Otherwise the operation is non-blocking and returns `null` if no items are immediately available. The returned values are moved into the _dequeued_state.
### Requeue
```
REQUEUE queue {id | ANY} [DEADLINE milliseconds-timestamp | DELAY milliseconds]
OK
```
Requeue a dequeued value by `id`, returning it to pending status. If not specified, deadline will default to now. "ANY" may be specified in lieu of an ID in which case an arbitrary dequeued value will be requeued.
### Release
```
RELEASE queue {id | ANY}
OK
```
Release a dequeued value by `id`. "ANY" may be specified in lieu of an ID in which case an arbitrary dequeued value will be released.
### Peek
```
PEEK queue
(integer) id
(integer) deadline
(integer) enqueue-time
(integer) requeue-time
(integer) dequeue-count
(bulk) value
```
Returns, but does not dequeue the next pending value from the `queue`. Returns `null` if the queue is empty.
### Stat
```
STAT queue
(integer) pending-count
(integer) dequeued-count
```
Returns statistics for the `queue` including the number of _pending_ and _dequeued_ values. The sum of these values is the total size of the queue. The _pending_ count includes values whose deadlines lie in the future.