event

Documentation

Index

• Variables
• type Merger
  • func (this *Merger) Close()
  • func (this *Merger) Merge(publisher gopi.Publisher)
  • func (this *Merger) Unmerge(publisher gopi.Publisher)
• type Publisher
  • func (this *Publisher) Close()
  • func (this *Publisher) Emit(evt gopi.Event)
  • func (this *Publisher) Subscribe() <-chan gopi.Event
  • func (this *Publisher) Unsubscribe(subscriber <-chan gopi.Event)
• type Signal
• type TaskFunc
• type Tasks
  • func (this *Tasks) Close() error
  • func (this *Tasks) Start(funcs ...TaskFunc)

Variables

var DONE = Signal{}

var (
	NullEvent = &nullEvent{}
)

Types

type Merger

type Merger struct {
	sync.Mutex
	Publisher
	// contains filtered or unexported fields
}

func (*Merger) Close

func (this *Merger) Close()

func (*Merger) Merge

func (this *Merger) Merge(publisher gopi.Publisher)

func (*Merger) Unmerge

func (this *Merger) Unmerge(publisher gopi.Publisher)

type Publisher

type Publisher struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*Publisher) Close

func (this *Publisher) Close()

Close will unsubscribe all remaining channels

func (*Publisher) Emit

func (this *Publisher) Emit(evt gopi.Event)

Emit an event onto all subscriber channels, this method will block if the subscribers are not processing incoming events

func (*Publisher) Subscribe

func (this *Publisher) Subscribe() <-chan gopi.Event

Subscribe returns a new channel on which emitting events can occur

func (*Publisher) Unsubscribe

func (this *Publisher) Unsubscribe(subscriber <-chan gopi.Event)

Unsubscribe closes a channel and removes it from the list of channels which emitting can happen on

type Signal

type Signal struct{}

type TaskFunc

type TaskFunc func(start chan<- Signal, stop <-chan Signal) error

type Tasks

type Tasks struct {
	sync.WaitGroup
	// contains filtered or unexported fields
}

func (*Tasks) Close

func (this *Tasks) Close() error

Close sends done signals to each go routine and will return any error from the tasks. Each go routine may end before the 'stop' signal is returned...

func (*Tasks) Start

func (this *Tasks) Start(funcs ...TaskFunc)

Start tasks in the background and waits for all "start" signals to be returned before unblocking