partybus

README

gopartybus

An event bus in go.

Documentation

Index

• Variables
• func Join(cs ...<-chan Event) <-chan Event
• type Bus
  • func NewBus() *Bus
  • func (bus *Bus) Close()
  • func (bus *Bus) Publish(event Event)
  • func (bus *Bus) Subscribe(eTypes ...EventType) *Subscription
  • func (bus *Bus) Unsubscribe(sub *Subscription) error
• type Event
• type EventType
• type Handler
• type Publisher
• type Responder
• type Subscriber
• type Subscription
  • func (s *Subscription) Events() <-chan Event
  • func (s *Subscription) Unsubscribe() error
• type SubscriptionId
• type Unsubscribable

Variables

var ErrUnsubscribe = fmt.Errorf("unable to find subscription to unsubscribe")

Functions

func Join

func Join(cs ...<-chan Event) <-chan Event

Types

type Bus

type Bus struct {
	// contains filtered or unexported fields
}

func NewBus

func NewBus() *Bus

func (*Bus) Close

func (bus *Bus) Close()

func (*Bus) Publish

func (bus *Bus) Publish(event Event)

func (*Bus) Subscribe

func (bus *Bus) Subscribe(eTypes ...EventType) *Subscription

func (*Bus) Unsubscribe

func (bus *Bus) Unsubscribe(sub *Subscription) error

type Event

type Event struct {
	Type   EventType
	Source interface{}
	Value  interface{}
	Error  error
}

type EventType

type EventType string

type Handler

type Handler interface {
	Handle(Event) error
}

type Publisher

type Publisher interface {
	Publish(Event)
}

type Responder

type Responder interface {
	RespondsTo() []EventType
}

type Subscriber

type Subscriber interface {
	Subscribe(...EventType) *Subscription
}

type Subscription

type Subscription struct {
	// contains filtered or unexported fields
}

func (*Subscription) Events

func (s *Subscription) Events() <-chan Event

func (*Subscription) Unsubscribe

func (s *Subscription) Unsubscribe() error

type SubscriptionId

type SubscriptionId int64

type Unsubscribable

type Unsubscribable interface {
	Unsubscribe() error
}