EventBus

Package EventBus is the little and lightweight eventbus for GoLang.

Installation

Make sure that Go is installed on your computer. Type the following command in your terminal:

go get github.com/asaskevich/EventBus

After it the package is ready to use.

Import package in your project

Add following line in your *.go file:

import "github.com/asaskevich/EventBus"

If you unhappy to use long EventBus, you can do something like this:

import (
	evbus "github.com/asaskevich/EventBus"
)

Example

func calculator(a int, b int) {
	fmt.Printf("%d\n", a + b)
}

func main() {
	bus := EventBus.New();
	bus.Subscribe("main:calculator", calculator);
	bus.Publish("main:calculator", 20, 40);
	bus.Unsubscribe("main:calculator");
}

Implemented methods

New()
Subscribe()
SubscribeOnce()
Unsubscribe()
Publish()

New()

New returns new EventBus with empty handlers.

bus := EventBus.New();

Subscribe(channel string, fn interface{})

Subscribe to a channel.

func Handler() { ... }
...
bus.Subscribe("channel:handler", Handler)

SubscribeOnce(channel string, fn interface{})

Subscribe to a channel once. Handler will be removed after executing.

func HelloWorld() { ... }
...
bus.SubscribeOnce("channel:handler", HelloWorld)

Unsubscribe(channel string)

Remove callback defined for a channel.

bus.Unsubscribe("channel:handler");

Publish(channel string, args ...interface{})

Execute callback defined for a channel. Any addional argument will be tranfered to the callback.

func Handler(str string) { ... }
...
bus.Subscribe("channel:handler", Handler)
...
bus.Publish("channel:handler", "Hello, World!");

Support

If you do have a contribution for the package feel free to put up a Pull Request or open Issue.

dominikschulz / EventBus