registry

Documentation

Overview

Package registry is an interface for service discovery

Index

• Variables
• type Node
• type Option
  • func Addrs(addrs ...string) Option
  • func Timeout(t time.Duration) Option
• type Options
• type RegisterOption
  • func RegisterTTL(t time.Duration) RegisterOption
• type RegisterOptions
• type Registry
• type Result
• type Service
• type WatchOption
  • func WatchService(name string) WatchOption
• type WatchOptions
• type Watcher

Variables

var (
	// ErrNotFound Not found error when GetService is called
	ErrNotFound = errors.New("not found")
	// ErrWatcherStopped Watcher stopped error when watcher is stopped
	ErrWatcherStopped = errors.New("watcher stopped")
)

Types

type Node

type Node struct {
	ID       string            `json:"id"`
	Address  string            `json:"address"`
	Metadata map[string]string `json:"metadata"`
}

Node 节点信息

type Option

type Option func(*Options)

Option option

func Addrs

func Addrs(addrs ...string) Option

Addrs is the registry addresses to use

func Timeout

func Timeout(t time.Duration) Option

Timeout timeout

type Options

type Options struct {
	Addrs   []string
	Timeout time.Duration
	// Other options for implementations of the interface
	// can be stored in a context
	Context context.Context
}

Options options

type RegisterOption

type RegisterOption func(*RegisterOptions)

RegisterOption register option

func RegisterTTL

func RegisterTTL(t time.Duration) RegisterOption

RegisterTTL ttl

type RegisterOptions

type RegisterOptions struct {
	TTL time.Duration
	// Other options for implementations of the interface
	// can be stored in a context
	Context context.Context
}

RegisterOptions register options

type Registry

type Registry interface {
	Init(...Option) error
	Options() Options
	Register(*Service, ...RegisterOption) error
	Deregister(*Service) error
	GetService(string) ([]*Service, error)
	ListServices() ([]*Service, error)
	Watch(...WatchOption) (Watcher, error)
	String() string
}

Registry The registry provides an interface for service discovery and an abstraction over varying implementations {consul, etcd, zookeeper, ...}

type Result

type Result struct {
	Action  string
	Service *Service
}

Result is returned by a call to Next on the watcher. Actions can be create, update, delete

type Service

type Service struct {
	Name    string  `json:"name"`
	Version string  `json:"version"`
	Nodes   []*Node `json:"nodes"`
}

Service 微服务对应的所有节点信息

type WatchOption

type WatchOption func(*WatchOptions)

WatchOption watch option

func WatchService

func WatchService(name string) WatchOption

WatchService Watch a service

type WatchOptions

type WatchOptions struct {
	// Specify a service to watch
	// If blank, the watch is for all services
	Service string
	// Other options for implementations of the interface
	// can be stored in a context
	Context context.Context
}

WatchOptions watch options

type Watcher

type Watcher interface {
	// Next is a blocking call
	Next() (*Result, error)
	Stop()
}

Watcher is an interface that returns updates about services within the registry.