Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/janos/feed
Topic based Subscription Feed
https://github.com/janos/feed
fan-out fanout generics go golang subscriptions
Last synced: about 1 month ago
JSON representation
Topic based Subscription Feed
- Host: GitHub
- URL: https://github.com/janos/feed
- Owner: janos
- License: bsd-3-clause
- Created: 2022-01-16T23:56:35.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-24T09:52:59.000Z (over 2 years ago)
- Last Synced: 2024-06-21T01:46:33.044Z (5 months ago)
- Topics: fan-out, fanout, generics, go, golang, subscriptions
- Language: Go
- Homepage:
- Size: 17.6 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Topic based Fan-Out Subscriptions
[](https://github.com/janos/feed/actions)
[](https://pkg.go.dev/resenje.org/feed)
[](https://newreleases.io/github/janos/feed)
This Go module provides fan-out synchronization methods using topic based dynamic subscriptions. Two types are available: Feed and Trigger.
## Feed
Feed is sending the same message to all subscribers. All messages are sent with preserved order and the delivery is guaranteed.
Example usage where topics are strings and messages some of a defined struct type.
```go
// define feed message type
type Message struct {
ID int
Text string
}
f := feed.NewFeed[string, Message]()
defer f.Close()
// subscribe to the feed topic "info"
subscription1, cancel1 := f.Subscribe("info")
defer cancel1()
go func() {
for m := range subscription1 {
fmt.Println("subscription 1 got message", m)
}
}()
// subscribe to the feed topic "info", again
subscription2, cancel2 := f.Subscribe("info")
defer cancel2()
go func() {
for m := range subscription2 {
fmt.Println("subscription 2 got message", m)
}
}()
// send some messages to both subscriptions
f.Send("info", Message{
ID: 25,
Text: "Hello, there.",
})
f.Send("info", Message{
ID: 101,
Text: "Something happened",
})
f.Send("info", Message{
ID: 106,
Text: "Something else happened",
})
```
## Trigger
Trigger is notifying subscribers if an event happened. If multiple events have happened, only one trigger event will be received by subscribers. This approach is ensuring that no unnecessary repetition of events happens and that appropriate action is done once after the event is received.
```go
t := feed.NewTrigger[int]()
// subscribe to topic 100
subscription1, cancel1 := t.Subscribe(100)
defer cancel1()
go func() {
for range subscription1 {
// do something
}
}()
// subscribe to topic 100
subscription2, cancel2 := t.Subscribe(100)
defer cancel2()
go func() {
for range subscription2 {
// do something
}
}()
// send a few events to the topic 1
t.Trigger(100)
t.Trigger(100)
t.Trigger(100)
```
## Installation
Run `go get -u resenje.org/feed` from command line.
## License
This application is distributed under the BSD-style license found in the [LICENSE](LICENSE) file.