https://github.com/ostafen/rustle
An HTTP-based in-memory broker inspired by Redis.
https://github.com/ostafen/rustle
broker golang in-memory redis restful-api
Last synced: 18 days ago
JSON representation
An HTTP-based in-memory broker inspired by Redis.
- Host: GitHub
- URL: https://github.com/ostafen/rustle
- Owner: ostafen
- Created: 2022-03-13T19:26:08.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-19T14:04:00.000Z (about 3 years ago)
- Last Synced: 2025-03-25T12:51:03.455Z (about 1 month ago)
- Topics: broker, golang, in-memory, redis, restful-api
- Language: Go
- Homepage:
- Size: 43.9 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rustle
Rustle is a simple, in-memory broker written in pure Golang. Design has been inspired by **Redis Streams**.
## Features
- It allows multiple clients to cooperate through the **Consumer Group** concept
- In-memory streams allow to overcome the limitations of a log files
- Clean and intuitive RESTful APIs make it suitable for the web
## Introduction to Rustle
In Rustle, streams are primarily an append only data structure, abstracting a continuous flow of message entries. A stream entry a json-object containing a "data" field and some additional infos.
You can easily create a new stream by runnning the following curl command:
```bash
foo@bar:~$ curl -X PUT -i localhost:8080/streams/myStream
```
where "myStream" is the name of the stream to be created. Upon success, the command will output an HTTP 201 response.
To start listening from the created stream, type the following command in a new terminal window:
```bash
foo@bar:~$ curl localhost:8080/streams/myStream/messages
```
This will create an SSE subscription which can be used to listen for each new incoming message. To verify that all is working properly, let us push some messages to the new stream.
```bash
foo@bar:~$ for i in {1..10}; do curl -X POST -i localhost:8080/streams/myStream \
-d "\"Hello, this is a test message\""; done;
```
You should see a sequence of ten json objects arriving from the active subscription with a format like this:
```bash
{"id": ..., "timestamp": ...,"stream": "myStream","data": "Hello, this is a test message"}
```
As you can see, each message reports the **timestamp** related to the instant the message has been received by the server, a random generated **uuid**, and the **name** of the stream the message has been submitted to. The actual content of the message is instead stored in the **data** field.
## Contribute
The software is still at early stages. Any contribution, in the form of a suggestion, bug report or pull request, can be useful and is well accepted :blush: