Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pilagod/go-eventbus
Event bus for Go
https://github.com/pilagod/go-eventbus
event event-bus event-publisher event-subscriber go golang
Last synced: 19 days ago
JSON representation
Event bus for Go
- Host: GitHub
- URL: https://github.com/pilagod/go-eventbus
- Owner: pilagod
- License: mit
- Created: 2021-02-13T04:58:38.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-02-16T15:24:33.000Z (almost 4 years ago)
- Last Synced: 2024-06-19T11:34:47.843Z (7 months ago)
- Topics: event, event-bus, event-publisher, event-subscriber, go, golang
- Language: Go
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-eventbus [](https://travis-ci.com/pilagod/go-eventbus) [](https://coveralls.io/github/pilagod/go-eventbus?branch=master) [](https://goreportcard.com/report/github.com/pilagod/go-eventbus)
Event bus for Go, leveraging [ants](https://github.com/panjf2000/ants) for worker pool management.
## Installation
```shell
$ go get -u github.com/pilagod/go-eventbus
```
## Usage
You should import `eventbus` module under `go-eventbus`:
```go
import "github.com/pilagod/go-eventbus/eventbus"
```
### Initialization
Event bus must be setup beforehead:
```go
var workerPoolSize = 4
func main() {
// ...
eb, err := eventbus.Setup(workerPoolSize)
if err != nil {
panic(err.Error())
}
// don't forget to release workers
defer eb.Release()
// ...
}
```
### Event Subscriber
```go
type Event struct {
Message string
}
type EventHandler struct {}
func (h *EventHandler) Handle(event eventbus.Event) error {
e, ok := event.(Event)
if !ok {
// just ignore this event
return nil
}
fmt.Println(e.Message)
return nil
}
es := eventbus.GetEventSubscriber() // GetEventSubscriber will panic if event bus hasn't setup
// Subscribe handler to specific event
es.Subscribe(Event{}, &EventHandler{})
// Subscribe handler to all events
es.SubscribeAll(&EventHandler{})
```
You can hook common handler logic by `Use` method:
```go
func LogHandler(h eventbus.EventHandler) eventbus.EventHandler {
return &logHandler{h}
}
type logHandler struct {
eventbus.EventHandler
}
func (h *logHandler) Handle(event eventbus.Event) error {
fmt.Println("Log event: %v", event)
return h.EventHandler.Handle(event)
}
es := eventbus.GetEventSubscriber()
// Hook logger for handler
es.Use(LogHandler)
```
### Event Publisher
```go
type Event struct {
Message string
}
ep := eventbus.GetEventPublisher() // GetEventPublisher will panic if event bus hasn't setup
// Publish specific event
e := Event{
Message: "Hello World",
}
ep.Publish(e)
// Publish multiple events
es := []eventbus.Event{
Event{Message: "A"},
Event{Message: "B"},
Event{Message: "C"},
}
ep.Publish(es...)
```
## License
© Cyan Ho (pilagod), 2021-NOW
Released under the [MIT License](https://github.com/pilagod/go-eventbus/blob/master/LICENSE)