configz

Documentation

Index

• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func CreateTopic(topic SinkTopic) fw.Topic
• func MustAsset(name string) []byte
• func Register(topic SinkTopic)
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type SinkTopic

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func CreateTopic

func CreateTopic(topic SinkTopic) fw.Topic

CreateTopic creates and returns a configz topic from the given MCP client. It does not do any registration.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func Register

func Register(topic SinkTopic)

Register the Configz topic for the given sink. TODO: Multi-client registration is currently not supported. We should update the topic, so that we can show output from multiple clients.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type SinkTopic

type SinkTopic interface {
	SnapshotRequestInfo() []sink.RecentRequestInfo
	Metadata() map[string]string
	ID() string
	Collections() []string
}

SinkTopic defines the expected interface for producing configz data from an MCP sink.