subscriber

Documentation

Index

• type Subscriber
  • func NewSubscriber() *Subscriber
  • func (s *Subscriber) Notify(events []types.EntityEvent)
  • func (s *Subscriber) Subscribe(cardinality collectors.TagCardinality, events []types.EntityEvent) chan []types.EntityEvent
  • func (s *Subscriber) Unsubscribe(ch chan []types.EntityEvent)

Types

type Subscriber

type Subscriber struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Subscriber allows processes to subscribe to entity events generated from a tagger.

func NewSubscriber

func NewSubscriber() *Subscriber

NewSubscriber returns a new subscriber.

func (*Subscriber) Notify

func (s *Subscriber) Notify(events []types.EntityEvent)

Notify sends a slice of EntityEvents to all registered subscribers at their chosen cardinality.

func (*Subscriber) Subscribe

func (s *Subscriber) Subscribe(cardinality collectors.TagCardinality, events []types.EntityEvent) chan []types.EntityEvent

Subscribe returns a channel that receives a slice of events whenever an entity is added, modified or deleted. It can send an initial burst of events only to the new subscriber, without notifying all of the others.

func (*Subscriber) Unsubscribe

func (s *Subscriber) Unsubscribe(ch chan []types.EntityEvent)

Unsubscribe ends a subscription to entity events and closes its channel.