mirror of
https://git.mills.io/prologic/msgbus.git
synced 2024-07-01 19:21:46 +00:00
123 lines
3.4 KiB
Markdown
123 lines
3.4 KiB
Markdown
# msgbus
|
|
|
|
[](https://travis-ci.org/prologic/msgbus)
|
|
[](https://codecov.io/gh/prologic/msgbus)
|
|
[](https://goreportcard.com/report/prologic/msgbus)
|
|
[](https://godoc.org/github.com/prologic/msgbus)
|
|
|
|
A distirbuted, scalable Message Bus server and library written in Go
|
|
|
|
**Status:** Alpha Software. This is considered "alpha quality" and is actively
|
|
being developed, tested and evolved with other projects and use-cases.
|
|
|
|
**Update:** (*2017-08-07*) This is now being used by [autodock](https://github.com/prologic/autodock) and is undergoing heavy development to deliver what is laid out here.
|
|
|
|
## Install
|
|
|
|
```#!bash
|
|
$ go install github.com/prologic/msgbus/...
|
|
```
|
|
|
|
## Usage (library)
|
|
|
|
Install the package into your project:
|
|
|
|
```#!bash
|
|
$ go get github.com/prologic/msgbus
|
|
```
|
|
|
|
Use the `MessageBus` type either directly:
|
|
|
|
```#!go
|
|
package main
|
|
|
|
import (
|
|
"log"
|
|
|
|
"github.com/prologic/msgbus"
|
|
)
|
|
|
|
func main() {
|
|
m := msgbus.NewMessageBus()
|
|
m.Put("foo", m.NewMessage([]byte("Hello World!")))
|
|
|
|
msg, ok := m.Get("foo")
|
|
if !ok {
|
|
log.Printf("No more messages in queue: foo")
|
|
} else {
|
|
log.Printf(
|
|
"Received message: id=%s topic=%s payload=%s",
|
|
msg.ID, msg.Topic, msg.Payload,
|
|
)
|
|
}
|
|
}
|
|
```
|
|
|
|
Running this example should yield something like this:
|
|
|
|
```#!bash
|
|
$ go run examples/hello.go
|
|
2017/08/09 03:01:54 [msgbus] PUT id=0 topic=foo payload=Hello World!
|
|
2017/08/09 03:01:54 [msgbus] NotifyAll id=0 topic=foo payload=Hello World!
|
|
2017/08/09 03:01:54 [msgbus] GET topic=foo
|
|
2017/08/09 03:01:54 Received message: id=%!s(uint64=0) topic=foo payload=Hello World!
|
|
```
|
|
|
|
See the [godoc](https://godoc.org/github.com/prologic/msgbus) for further
|
|
documentation and other examples.
|
|
|
|
## Usage (tool)
|
|
|
|
Run the message bus daemon/server:
|
|
|
|
```#!bash
|
|
$ msgbusd
|
|
2017/08/07 01:11:16 [msgbus] Subscribe id=[::1]:55341 topic=foo
|
|
2017/08/07 01:11:22 [msgbus] PUT id=0 topic=foo payload=hi
|
|
2017/08/07 01:11:22 [msgbus] NotifyAll id=0 topic=foo payload=hi
|
|
2017/08/07 01:11:26 [msgbus] PUT id=1 topic=foo payload=bye
|
|
2017/08/07 01:11:26 [msgbus] NotifyAll id=1 topic=foo payload=bye
|
|
2017/08/07 01:11:33 [msgbus] GET topic=foo
|
|
2017/08/07 01:11:33 [msgbus] GET topic=foo
|
|
2017/08/07 01:11:33 [msgbus] GET topic=foo
|
|
```
|
|
|
|
Subscribe to a topic using the message bus client:
|
|
|
|
```#!bash
|
|
$ msgbus sub foo
|
|
2017/08/07 01:11:22 [msgbus] received message: id=0 topic=foo payload=hi
|
|
2017/08/07 01:11:26 [msgbus] received message: id=1 topic=foo payload=bye
|
|
```
|
|
|
|
Send a few messages with the message bus client:
|
|
|
|
```#!bash
|
|
$ msgbus pub foo hi
|
|
$ msgbus pub foo bye
|
|
```
|
|
|
|
You can also manually pull messages using the client:
|
|
|
|
```#!bash
|
|
$ msgbus pull foo
|
|
2017/08/07 01:11:33 [msgbus] received message: id=0 topic=foo payload=hi
|
|
2017/08/07 01:11:33 [msgbus] received message: id=1 topic=foo payload=bye
|
|
```
|
|
|
|
> This is slightly different from a listening subscriber (*using websockets*) where messages are pulled directly.
|
|
|
|
## Design
|
|
|
|
Design decisions so far:
|
|
|
|
* In memory queues (*may extend this with interfaces and persistence*)
|
|
* HTTP API
|
|
* Websockets for realtime push of events
|
|
* Sequence ID Message tracking
|
|
* Pull and Push model
|
|
|
|
## License
|
|
|
|
msgbus is licensed under the [MIT License](https://github.com/prologic/msgbus/blob/master/LICENSE)
|