Mirrors
/
prologic-msgbus
mirror of https://git.mills.io/prologic/msgbus.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md

This commit is contained in:
James Mills 2017-08-07 01:15:56 -07:00 committed by GitHub
parent a56c04cbbe
commit b348af1651
1 changed files with 33 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -1,7 +1,11 @@
A Message Bus server and library written in Go
# msgbus
A distirbuted, scalable Message Bus server and library written in Go
**WIP:** THis is still highly experimental and not fit for production use.
**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
@ -14,31 +18,51 @@ 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/06/07 21:52:27 Listening for messages from ws://localhost:8000/push/foo
2017/06/07 21:52:36 Received: hello
2017/06/07 21:52:50 Received: hello
^C
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 hello
$ msgbus pub foo hello
$ 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
* 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
Enjoy :)
## License
msgbus is licensed under the [MIT License](https://github.com/prologic/msgbus/blob/master/LICENSE)