go-observable
Golang script heavily inspired to riot-observable
It allows you to send and receive events with a tiny simple API (thread safe)
Installation
go get github.com/GianlucaGuarini/go-observableApi
New()
Create a new observable struct reference
o := observable.New()On(event string, fn interface{})
Subscribe a callback to a certain event key
o.On("ready", func() {
// I am ready!
})You can subscribe your observable also to multiple events for example:
o.On("stop error", func(args ...interface{}) {
// It will be called when the "error" or the "stop" event will be dispatched
// args[0] here is either "stop" or "error" depending on the Trigger call
})By using the * namespace you will be able to listen all the observable events
IMPORTANT
If you pass arguments to your listeners you should add them also to this listener
as well
o.On("*", func(args ...interface{}) {
// args[0] here will be the event key called in the Trigger method
// in this case "stop" and "start"
})
o.Trigger("stop").Trigger("start")Off(event string, fn interface{})
Unsubscribe a callback from an event key
onReady := func() {
// I am ready
}
o.On("ready", onReady)
// do your stuff...
o.Off("ready", onReady) // the onReady will not be called anymoreBy using the key * you will remove all the observed
o.On("ready", func() {
// ready
})
o.On("stop", func() {
// stop
})
o.Off("*") // kill all the listeners
o.Trigger("ready stop") // the callbacks above will never be calledOne(event string, fn interface{})
Subscribe a callback in order to be called only once
o.One("ready", func() {
// I am ready and I will not be called anymore
})Trigger(event string, arguments ...interface{})
Call all the callbacks subscribed to a certain event
o.On("message", func(message string) {
// do something with the message
})
o.Trigger("message", "Hello There!")