registry

Documentation

Index

• Constants
• func NewBalancer(r Registry)
• type Backend
• type Balancer
• type Context
• type Dao
• type Edge
• type Generic
• type Item
• type Node
• type Option
  • func WithAction(a pb.ActionType) Option
  • func WithFailFast() Option
  • func WithFilter(f func(Item) bool) Option
  • func WithMeta(name, value string) Option
  • func WithName(n string) Option
  • func WithType(t pb.ItemType) Option
• type Options
  • func (o *Options) Matches(name, itemName string) bool
• type RawRegistry
• type RegisterOption
  • func WithDeregisterFull() RegisterOption
  • func WithEdgeTo(id, label string, meta map[string]string) RegisterOption
  • func WithRegisterFailFast() RegisterOption
  • func WithWatch(wi StatusReporter) RegisterOption
• type RegisterOptions
• type Registry
  • func GraphRegistry(r RawRegistry) Registry
  • func OpenRegistry(ctx context.Context, urlstr string) (Registry, error)
• type Result
  • func NewResult(action pb.ActionType, items []Item) Result
• type Server
• type Service
• type Status
• type StatusReporter
• type StatusWatcher
• type URLMux
  • func DefaultURLMux() *URLMux
  • func (mux *URLMux) OpenRegistry(ctx context.Context, urlstr string) (Registry, error)
  • func (mux *URLMux) Register(scheme string, opener URLOpener)
  • func (mux *URLMux) Schemes() []string
  • func (mux *URLMux) ValidScheme(scheme string) bool
• type URLOpener
• type Watcher
  • func NewWatcher(id string, opts Options, res chan Result) Watcher

Constants

const (
	ServiceMetaOverride = "service-override"
)

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

type Dao interface {
	Item

	Driver() string
	Dsn() string
}

Dao stores a DAO in the registry

type Edge

type Edge interface {
	Item

	Vertices() []string
}

Edge links two vertices together

type Generic

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 Node

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

type Option

type Option func(*Options)

func WithAction

func WithAction(a pb.ActionType) Option

func WithFailFast

func WithFailFast() Option

func WithFilter

func WithFilter(f func(Item) bool) 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
	Action   pb.ActionType
	Names    []string
	Types    []pb.ItemType
	Filters  []func(item Item) bool
}

func (*Options) Matches

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

type RawRegistry

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)

	As(interface{}) bool
}

type RegisterOption

type RegisterOption func(options *RegisterOptions)

func WithDeregisterFull

func WithDeregisterFull() RegisterOption

func WithEdgeTo

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

func WithRegisterFailFast

func WithRegisterFailFast() RegisterOption

func WithWatch

func WithWatch(wi StatusReporter) RegisterOption

type RegisterOptions

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

func GraphRegistry(r RawRegistry) 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

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

type Server

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

type Status string

const (
	MetaStatusKey             = "status"
	StatusStopped      Status = "stopped"
	StatusStarting     Status = "starting"
	StatusServing      Status = "serving"
	StatusReady        Status = "ready"
	StatusError        Status = "error"
	StatusStopping     Status = "stopping"
	MetaDescriptionKey        = "description"
)

type StatusReporter

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

type StatusWatcher

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

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

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