observable

Documentation

Index

• type Event
• type Implementation
  • func (implementation *Implementation) Notify(event Event)
  • func (implementation *Implementation) Observe(observer func(Event)) func()
• type Interface

Types

type Event

type Event struct {
	// Subject identifies what changed.
	// By convention, it corresponds to the corresponding GET endpoint of the REST API.
	Subject string `json:"subject"`

	// Action describes how the change has to be applied.
	Action action.Action `json:"action"`

	// Object contains the data that changed.
	Object interface{} `json:"object"`
}

Event is passed to the listeners of an observable type.

type Implementation

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

Implementation can be embedded in implementations that are observable.

func (*Implementation) Notify

func (implementation *Implementation) Notify(event Event)

Notify notifies the registered observers about the given event. This method should only be called from the implementation itself.

func (*Implementation) Observe

func (implementation *Implementation) Observe(observer func(Event)) func()

Observe implements observable.Observe.

type Interface

type Interface interface {
	// Observe registers the given callback and returns a function to unobserve again.
	Observe(func(Event)) func()
}

Interface can be embedded in interfaces that are observable.