metadata

Documentation

Overview

Package metadata implement the metadata events watcher.

Index

• Constants
• type Watcher
  • func New() *Watcher
  • func (mp *Watcher) Events() []string
  • func (mp *Watcher) ID() string
  • func (mp *Watcher) Run(ctx context.Context, evType string) (bool, interface{}, error)

Constants

const (
	// WatcherID is the metadata watcher's ID.
	WatcherID = "metadata-watcher"
	// LongpollEvent is the metadata's longpoll event type ID.
	LongpollEvent = "metadata-watcher,longpoll"
)

Types

type Watcher

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

Watcher is the metadata event watcher implementation.

func New

func New() *Watcher

New allocates and initializes a new Watcher.

func (*Watcher) Events

func (mp *Watcher) Events() []string

Events returns an slice with all implemented events.

func (*Watcher) ID

func (mp *Watcher) ID() string

ID returns the metadata event watcher id.

func (*Watcher) Run

func (mp *Watcher) Run(ctx context.Context, evType string) (bool, interface{}, error)

Run listens to metadata changes and report back the event.