https://github.com/vancluever/fspubsub
A simple file-system based streaming event store
https://github.com/vancluever/fspubsub
event-sourcing go golang messaging pubsub
Last synced: about 2 months ago
JSON representation
A simple file-system based streaming event store
- Host: GitHub
- URL: https://github.com/vancluever/fspubsub
- Owner: vancluever
- License: unlicense
- Archived: true
- Created: 2017-06-04T19:07:43.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-11-08T19:41:54.000Z (over 6 years ago)
- Last Synced: 2025-02-03T11:15:03.296Z (3 months ago)
- Topics: event-sourcing, go, golang, messaging, pubsub
- Language: Go
- Homepage:
- Size: 48.8 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://godoc.org/github.com/vancluever/fspubsub)
# fspubsub
`fspubsub` is a very simple streaming event store, good to demonstrate the
basics of event publishing and subscription. It publishes events directly to the
filesystem, with the subscriber listening to the publishing location with
inotify. It also has facilities to pull the entire current store, and a single
event.
Note that the hook on inotify events currently means that this package is
supported on Linux only.
## Usage Synopsis
Streams are named for the type of event they support. An event is a type,
although realistically, it is probably a struct:
```
type TestEvent struct {
Text string
}
```
Using the above type, you can start a stream by creating a publisher for the
event you will be publishing to:
```
p, err := pub.NewPublisher("./", TestEvent{})
if err != nil {
return log.Fatalf("[FATAL] Could not create stream: %s", err)
}
```
Note that the struct that you pass to the event in `NewPublisher` does not need
to have data in it, and in fact is ignored if there is any.
After the publisher is created, sending the event is as easy as sending the
struct along:
```
e := &TestEvent{Text: "Foo"}
id, err := p.Publish(e)
if err != nil {
return log.Fatalf("[FATAL] Could not publish event: %s", err)
}
```
To listen for events on the stream, create a new subscriber via `NewSubscriber`.
You can then use `Queue` to get a channel where you can watch for events, and
`Done` to get a channel that will close when the stream is done or fails for
some other reason. The error will be in `Error` when done, if any.
```
s, err := sub.NewSubscriber(wd, TestEvent{})
if err != nil {
log.Fatalf("[FATAL] Cannot create subscriber: %s", err)
}
go func() {
for {
select {
case event := <-s.Queue():
// Do something with event here
case <-s.Done():
return
}
}
}()
<-s.Done()
if s.Error() != nil {
log.Fatalf("[FATAL] Error while listening to events: %s", s.Error())
}
```
For full details, see the [GoDoc](https://godoc.org/github.com/vancluever/fspubsub).
## License
```
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to
```