micro/registry/registry.go

85 lines
2.3 KiB
Go
Raw Normal View History

2016-12-14 15:41:48 +00:00
// Package registry is an interface for service discovery
2015-01-13 23:31:27 +00:00
package registry
2016-02-25 12:42:31 +00:00
import (
"errors"
)
const (
// WildcardDomain indicates any domain
WildcardDomain = "*"
// DefaultDomain to use if none was provided in options
DefaultDomain = "micro"
)
var (
DefaultRegistry Registry = newRegistry()
// ErrNotFound returned when GetService is called and no services found
ErrNotFound = errors.New("service not found")
// ErrWatcherStopped returned when when watcher is stopped
ErrWatcherStopped = errors.New("watcher stopped")
)
2016-01-30 21:13:34 +00:00
// The registry provides an interface for service discovery
// and an abstraction over varying implementations
// {consul, etcd, zookeeper, ...}
2015-01-13 23:31:27 +00:00
type Registry interface {
Init(...Option) error
Options() Options
2016-01-26 23:32:27 +00:00
Register(*Service, ...RegisterOption) error
2020-04-14 12:32:59 +01:00
Deregister(*Service, ...DeregisterOption) error
GetService(string, ...GetOption) ([]*Service, error)
ListServices(...ListOption) ([]*Service, error)
2018-02-19 17:12:37 +00:00
Watch(...WatchOption) (Watcher, error)
2015-12-19 21:56:14 +00:00
String() string
}
// Service holds service registry info
2020-04-12 10:58:12 +01:00
type Service struct {
Name string `json:"name"`
Version string `json:"version"`
Metadata map[string]string `json:"metadata"`
Endpoints []*Endpoint `json:"endpoints"`
Nodes []*Node `json:"nodes"`
}
// Node holds node registry info
2020-04-12 10:58:12 +01:00
type Node struct {
Id string `json:"id"`
Address string `json:"address"`
Metadata map[string]string `json:"metadata"`
}
// Endpoint holds endpoint registry info
2020-04-12 10:58:12 +01:00
type Endpoint struct {
Name string `json:"name"`
Request *Value `json:"request"`
Response *Value `json:"response"`
Metadata map[string]string `json:"metadata"`
}
// Valud holds additional kv stuff
2020-04-12 10:58:12 +01:00
type Value struct {
Name string `json:"name"`
Type string `json:"type"`
Values []*Value `json:"values"`
}
// Option func signature
2015-12-19 18:28:08 +00:00
type Option func(*Options)
// RegisterOption option is used to register service
2016-01-26 23:32:27 +00:00
type RegisterOption func(*RegisterOptions)
// WatchOption option is used to watch service changes
2018-02-19 17:12:37 +00:00
type WatchOption func(*WatchOptions)
// DeregisterOption option is used to deregister service
2020-04-14 12:32:59 +01:00
type DeregisterOption func(*DeregisterOptions)
// GetOption option is used to get service
2020-04-14 12:32:59 +01:00
type GetOption func(*GetOptions)
// ListOption option is used to list services
2020-04-14 12:32:59 +01:00
type ListOption func(*ListOptions)