notifications

Documentation

Index

• type Event
• type Publisher
  • func NewPublisher() Publisher
• type Subscribable
• type Subscriber
• type Topic
• type TopicData

Types

type Event

type Event interface{}

Event is a publishable event

type Publisher

type Publisher interface {
	Close(Topic)
	Publish(Topic, Event)
	Shutdown()
	Startup()
	Subscribable
}

Publisher is an publisher of events that can be subscribed to

func NewPublisher

func NewPublisher() Publisher

NewPublisher returns a new message event publisher

type Subscribable

type Subscribable interface {
	Subscribe(topic Topic, sub Subscriber) bool
	Unsubscribe(sub Subscriber) bool
}

Subscribable is a stream that can be subscribed to

type Subscriber

type Subscriber interface {
	OnNext(Topic, Event)
	OnClose(Topic)
}

Subscriber is a subscriber that can receive events

type Topic

type Topic interface{}

Topic is a topic that events appear on

type TopicData

type TopicData interface{}

TopicData is data added to every message broadcast on a topic