registry

package
v4.2.2-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 8, 2023 License: AGPL-3.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	MetaStatusKey             = "status"
	StatusStopped      Status = "stopped"
	StatusStarting     Status = "starting"
	StatusReady        Status = "ready"
	StatusError        Status = "error"
	StatusStopping     Status = "stopping"
	StatusTransient    Status = "transient"
	StatusWaiting      Status = "waiting"
	MetaDescriptionKey        = "description"
	MetaUniqueKey             = "unique"
	MetaTimestampKey          = "timestamp"
)
View Source 
const (
	ServiceMetaOverride = "service-override"
)

Variables

This section is empty.

Functions

func NewBalancer 

func NewBalancer(r Registry)

Types

type Backend 

type Backend struct {
	Alive bool

	ReverseProxy *httputil.ReverseProxy
	// contains filtered or unexported fields
}

type Balancer 

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

type Context 

type Context interface {
	Context(context.Context)
}

type Dao added in v4.0.1 

type Dao interface {
	Item

	Driver() string
	Dsn() string
}

Dao stores a DAO in the registry

type Edge added in v4.0.1 

type Edge interface {
	Item

	Vertices() []string
}

Edge links two vertices together

type Generic added in v4.0.1 

type Generic interface {
	Item

	Type() registry.ItemType
}

Generic is the simplest Item implementation

type Item 

type Item interface {
	Name() string
	ID() string
	Metadata() map[string]string
	As(interface{}) bool
}

Item is the main interface for registry items

type MetaSetter added in v4.0.6 

type MetaSetter interface {
	SetMetadata(map[string]string)
}

type MetaWrapper added in v4.0.6 

type MetaWrapper struct {
	Registry
	// contains filtered or unexported fields
}

func (*MetaWrapper) Register added in v4.0.6 

func (m *MetaWrapper) Register(item Item, opts ...RegisterOption) error

type Node 

type Node interface {
	Item
	Hostname() string
	IPs() []string
	AdvertiseIP() string
}

type Option 

type Option func(*Options)

func WithAction added in v4.0.1 

func WithAction(a pb.ActionType) Option

func WithContext added in v4.0.1 

func WithContext(ctx context.Context) Option

func WithFailFast added in v4.0.1 

func WithFailFast() Option

func WithFilter 

func WithFilter(f func(Item) bool) Option

func WithID added in v4.0.6 

func WithID(id string) Option

func WithMeta 

func WithMeta(name, value string) Option

func WithName 

func WithName(n string) Option

func WithType 

func WithType(t pb.ItemType) Option

type Options 

type Options struct {
	Context  context.Context
	FailFast bool
	Actions  []pb.ActionType
	IDs      []string
	Names    []string
	Types    []pb.ItemType
	Filters  []func(item Item) bool
}

func (*Options) ActionsMatch added in v4.0.1 

func (o *Options) ActionsMatch(eventAction pb.ActionType) bool

ActionsMatch checks if an Action filter matches input

func (*Options) Matches added in v4.0.1 

func (o *Options) Matches(name, itemName string) bool

type RawRegistry added in v4.0.1 

type RawRegistry interface {
	Start(Item) error
	Stop(Item) error
	Register(Item, ...RegisterOption) error
	Deregister(Item, ...RegisterOption) error
	Get(string, ...Option) (Item, error)
	List(...Option) ([]Item, error)
	Watch(...Option) (Watcher, error)
	NewLocker(name string) sync.Locker

	Close() error
	Done() <-chan struct{}

	As(interface{}) bool
}

type RegisterOption added in v4.0.1 

type RegisterOption func(options *RegisterOptions)

func WithDeregisterFull added in v4.0.1 

func WithDeregisterFull() RegisterOption

func WithEdgeTo added in v4.0.1 

func WithEdgeTo(id, label string, meta map[string]string) RegisterOption

func WithRegisterFailFast added in v4.0.1 

func WithRegisterFailFast() RegisterOption

func WithWatch added in v4.0.1 

func WithWatch(wi StatusReporter) RegisterOption

type RegisterOptions added in v4.0.1 

type RegisterOptions struct {
	Edges          []registerEdge
	Watch          interface{}
	FailFast       bool
	DeregisterFull bool
}

type Registry 

type Registry interface {
	RawRegistry
	RegisterEdge(item1, item2, edgeLabel string, metadata map[string]string, oo ...RegisterOption) (Edge, error)
	ListAdjacentItems(sourceItem Item, targetOptions ...Option) (items []Item)
}

func GraphRegistry added in v4.0.1 

func GraphRegistry(r RawRegistry) Registry

func NewMetaWrapper added in v4.0.6 

func NewMetaWrapper(reg Registry, f func(map[string]string), opts ...Option) Registry

func NewTransientWrapper added in v4.0.6 

func NewTransientWrapper(reg Registry, opts ...Option) Registry

func OpenRegistry 

func OpenRegistry(ctx context.Context, urlstr string) (Registry, error)

OpenRegistry opens the Registry identified by the URL given. See the URLOpener documentation in driver subpackages for details on supported URL formats, and https://gocloud.dev/concepts/urls for more information.

type Result 

type Result interface {
	Action() pb.ActionType
	Items() []Item
}

func NewResult added in v4.0.1 

func NewResult(action pb.ActionType, items []Item) Result

type Server added in v4.0.1 

type Server interface {
	Item
	Server()
}

Server represents a running server

type Service 

type Service interface {
	Item

	Version() string
	Tags() []string

	Start(oo ...RegisterOption) error
	Stop(oo ...RegisterOption) error

	ServerScheme() string
}

Service represents an instantiated service in the registry

type Status added in v4.0.1 

type Status string

type StatusReporter added in v4.0.1 

type StatusReporter interface {
	WatchStatus() (StatusWatcher, error)
}

type StatusWatcher added in v4.0.1 

type StatusWatcher interface {
	Next() (Item, error)
	Stop()
}

type TransientWrapper added in v4.0.6 

type TransientWrapper struct {
	Registry
	// contains filtered or unexported fields
}

func (*TransientWrapper) Register added in v4.0.6 

func (m *TransientWrapper) Register(item Item, opts ...RegisterOption) error

type URLMux 

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

URLMux is a URL opener multiplexer. It matches the scheme of the URLs against a set of registered schemes and calls the opener that matches the URL's scheme. See https://gocloud.dev/concepts/urls/ for more information.

The zero value is a multiplexer with no registered schemes.

func DefaultURLMux 

func DefaultURLMux() *URLMux

DefaultURLMux returns the URLMux used by OpenTopic and OpenSubscription.

Driver packages can use this to register their TopicURLOpener and/or SubscriptionURLOpener on the mux.

func (*URLMux) OpenRegistry 

func (mux *URLMux) OpenRegistry(ctx context.Context, urlstr string) (Registry, error)

OpenTopic calls OpenTopicURL with the URL parsed from urlstr. OpenTopic is safe to call from multiple goroutines.

func (*URLMux) Register 

func (mux *URLMux) Register(scheme string, opener URLOpener)

Register registers the opener with the given scheme. If an opener already exists for the scheme, Register panics.

func (*URLMux) Schemes 

func (mux *URLMux) Schemes() []string

Schemes returns a sorted slice of the registered schemes.

func (*URLMux) ValidScheme 

func (mux *URLMux) ValidScheme(scheme string) bool

ValidScheme returns true if scheme has been registered.

type URLOpener 

type URLOpener interface {
	OpenURL(ctx context.Context, u *url.URL) (Registry, error)
}

URLOpener represents types than can open Registries based on a URL. The opener must not modify the URL argument. OpenURL must be safe to call from multiple goroutines.

This interface is generally implemented by types in driver packages.

type Watcher 

type Watcher interface {
	Next() (Result, error)
	Stop()
}

func NewWatcher added in v4.0.1 

func NewWatcher(id string, opts Options, res chan Result) Watcher

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.