mirror of
https://source.quilibrium.com/quilibrium/ceremonyclient.git
synced 2024-12-27 09:05:18 +00:00
101 lines
3.0 KiB
Go
101 lines
3.0 KiB
Go
package event
|
|
|
|
import (
|
|
"io"
|
|
"reflect"
|
|
)
|
|
|
|
// SubscriptionOpt represents a subscriber option. Use the options exposed by the implementation of choice.
|
|
type SubscriptionOpt = func(interface{}) error
|
|
|
|
// EmitterOpt represents an emitter option. Use the options exposed by the implementation of choice.
|
|
type EmitterOpt = func(interface{}) error
|
|
|
|
// CancelFunc closes a subscriber.
|
|
type CancelFunc = func()
|
|
|
|
// wildcardSubscriptionType is a virtual type to represent wildcard
|
|
// subscriptions.
|
|
type wildcardSubscriptionType interface{}
|
|
|
|
// WildcardSubscription is the type to subscribe to receive all events
|
|
// emitted in the eventbus.
|
|
var WildcardSubscription = new(wildcardSubscriptionType)
|
|
|
|
// Emitter represents an actor that emits events onto the eventbus.
|
|
type Emitter interface {
|
|
io.Closer
|
|
|
|
// Emit emits an event onto the eventbus. If any channel subscribed to the topic is blocked,
|
|
// calls to Emit will block.
|
|
//
|
|
// Calling this function with wrong event type will cause a panic.
|
|
Emit(evt interface{}) error
|
|
}
|
|
|
|
// Subscription represents a subscription to one or multiple event types.
|
|
type Subscription interface {
|
|
io.Closer
|
|
|
|
// Out returns the channel from which to consume events.
|
|
Out() <-chan interface{}
|
|
|
|
// Name returns the name for the subscription
|
|
Name() string
|
|
}
|
|
|
|
// Bus is an interface for a type-based event delivery system.
|
|
type Bus interface {
|
|
// Subscribe creates a new Subscription.
|
|
//
|
|
// eventType can be either a pointer to a single event type, or a slice of pointers to
|
|
// subscribe to multiple event types at once, under a single subscription (and channel).
|
|
//
|
|
// Failing to drain the channel may cause publishers to block.
|
|
//
|
|
// If you want to subscribe to ALL events emitted in the bus, use
|
|
// `WildcardSubscription` as the `eventType`:
|
|
//
|
|
// eventbus.Subscribe(WildcardSubscription)
|
|
//
|
|
// Simple example
|
|
//
|
|
// sub, err := eventbus.Subscribe(new(EventType))
|
|
// defer sub.Close()
|
|
// for e := range sub.Out() {
|
|
// event := e.(EventType) // guaranteed safe
|
|
// [...]
|
|
// }
|
|
//
|
|
// Multi-type example
|
|
//
|
|
// sub, err := eventbus.Subscribe([]interface{}{new(EventA), new(EventB)})
|
|
// defer sub.Close()
|
|
// for e := range sub.Out() {
|
|
// select e.(type):
|
|
// case EventA:
|
|
// [...]
|
|
// case EventB:
|
|
// [...]
|
|
// }
|
|
// }
|
|
Subscribe(eventType interface{}, opts ...SubscriptionOpt) (Subscription, error)
|
|
|
|
// Emitter creates a new event emitter.
|
|
//
|
|
// eventType accepts typed nil pointers, and uses the type information for wiring purposes.
|
|
//
|
|
// Example:
|
|
// em, err := eventbus.Emitter(new(EventT))
|
|
// defer em.Close() // MUST call this after being done with the emitter
|
|
// em.Emit(EventT{})
|
|
Emitter(eventType interface{}, opts ...EmitterOpt) (Emitter, error)
|
|
|
|
// GetAllEventTypes returns all the event types that this bus knows about
|
|
// (having emitters and subscribers). It omits the WildcardSubscription.
|
|
//
|
|
// The caller is guaranteed that this function will only return value types;
|
|
// no pointer types will be returned.
|
|
GetAllEventTypes() []reflect.Type
|
|
}
|