meta

Documentation

Overview

Package meta provides tool for reading metadata from services declaring "MetaProvider" support

Index

• Constants
• type Loader
  • func NewStreamLoader(ctx context.Context) Loader
• type MetaProviderCloser
• type NamespacesProvider
  • func NewNamespacesProvider() *NamespacesProvider
  • func (p *NamespacesProvider) Clear()
  • func (p *NamespacesProvider) CloseStreamers() error
  • func (p *NamespacesProvider) ExcludeIndexes() map[string]struct{}
  • func (p *NamespacesProvider) IncludedIndexes() map[string]struct{}
  • func (p *NamespacesProvider) InitStreamers(ctx context.Context) error
  • func (p *NamespacesProvider) Load()
  • func (p *NamespacesProvider) Namespaces() map[string]*idm.UserMetaNamespace
  • func (p *NamespacesProvider) ReadNode(node *tree.Node) (*tree.Node, error)
  • func (p *NamespacesProvider) Watch()
• type StreamLoader
  • func (l *StreamLoader) Close() error
  • func (l *StreamLoader) LoadMetas(ctx context.Context, nodes ...*tree.Node)

Constants

const (
	ServiceMetaProvider   = "MetaProvider"
	ServiceMetaNsProvider = "MetaNsProvider"
)

Types

type Loader

type Loader interface {
	io.Closer
	LoadMetas(ctx context.Context, nodes ...*tree.Node)
}

func NewStreamLoader

func NewStreamLoader(ctx context.Context) Loader

type MetaProviderCloser

type MetaProviderCloser func() error

type NamespacesProvider

type NamespacesProvider struct {
	sync.RWMutex // this handles a lock for the namespaces field
	// contains filtered or unexported fields
}

NamespaceProvider list all namespaces info from services declared ServiceMetaNsProvider It watches events to maintain the list

func NewNamespacesProvider

func NewNamespacesProvider() *NamespacesProvider

NewNamespacesProvider creates a new namespace provider

func (*NamespacesProvider) Clear

func (p *NamespacesProvider) Clear()

Clear unload cached data to force reload at next call

func (*NamespacesProvider) CloseStreamers

func (p *NamespacesProvider) CloseStreamers() error

CloseStreamers closes all prepared streamer clients

func (*NamespacesProvider) ExcludeIndexes

func (p *NamespacesProvider) ExcludeIndexes() map[string]struct{}

ExcludeIndexes lists namespaces that should not be indexed by search engines

func (*NamespacesProvider) IncludedIndexes

func (p *NamespacesProvider) IncludedIndexes() map[string]struct{}

IncludedIndexes lists namespaces that should be indexed by search engines

func (*NamespacesProvider) InitStreamers

func (p *NamespacesProvider) InitStreamers(ctx context.Context) error

InitStreamers prepares a set of NodeProviderStreamerClients ready to be requested

func (*NamespacesProvider) Load

func (p *NamespacesProvider) Load()

Load finds all services declared as ServiceMetaNsProvider and call them to list the namespaces they declare

func (*NamespacesProvider) Namespaces

func (p *NamespacesProvider) Namespaces() map[string]*idm.UserMetaNamespace

Namespaces lists all known usermeta namespaces

func (*NamespacesProvider) ReadNode

func (p *NamespacesProvider) ReadNode(node *tree.Node) (*tree.Node, error)

ReadNode goes through all prepared streamers to collect metadata

func (*NamespacesProvider) Watch

func (p *NamespacesProvider) Watch()

Watch watches idm ChangeEvents to force reload when metadata namespaces are modified

type StreamLoader

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

func (*StreamLoader) Close

func (l *StreamLoader) Close() error

func (*StreamLoader) LoadMetas

func (l *StreamLoader) LoadMetas(ctx context.Context, nodes ...*tree.Node)