micro/registry/registry.go

65 lines
1.6 KiB
Go
Raw Normal View History

2016-12-14 18:41:48 +03:00
// Package registry is an interface for service discovery
2015-01-14 02:31:27 +03:00
package registry
2016-02-25 15:42:31 +03:00
import (
"errors"
)
2016-01-31 00:13:34 +03:00
// The registry provides an interface for service discovery
// and an abstraction over varying implementations
// {consul, etcd, zookeeper, ...}
2015-01-14 02:31:27 +03:00
type Registry interface {
Init(...Option) error
Options() Options
2016-01-27 02:32:27 +03:00
Register(*Service, ...RegisterOption) error
Deregister(*Service) error
2015-11-08 04:48:48 +03:00
GetService(string) ([]*Service, error)
ListServices() ([]*Service, error)
2018-02-19 20:12:37 +03:00
Watch(...WatchOption) (Watcher, error)
2015-12-20 00:56:14 +03:00
String() string
}
2015-12-19 21:28:08 +03:00
type Option func(*Options)
2016-01-27 02:32:27 +03:00
type RegisterOption func(*RegisterOptions)
2018-02-19 20:12:37 +03:00
type WatchOption func(*WatchOptions)
2015-01-14 02:31:27 +03:00
var (
2019-01-15 19:50:37 +03:00
DefaultRegistry = NewRegistry()
2016-02-25 15:42:31 +03:00
2018-12-04 19:41:40 +03:00
// Not found error when GetService is called
2016-02-25 15:42:31 +03:00
ErrNotFound = errors.New("not found")
2018-12-04 19:41:40 +03:00
// Watcher stopped error when watcher is stopped
ErrWatcherStopped = errors.New("watcher stopped")
2015-01-14 02:31:27 +03:00
)
2016-01-31 00:13:34 +03:00
// Register a service node. Additionally supply options such as TTL.
2016-01-27 02:32:27 +03:00
func Register(s *Service, opts ...RegisterOption) error {
return DefaultRegistry.Register(s, opts...)
2015-01-14 02:31:27 +03:00
}
2016-01-31 00:13:34 +03:00
// Deregister a service node
func Deregister(s *Service) error {
2015-01-14 02:31:27 +03:00
return DefaultRegistry.Deregister(s)
}
2016-01-31 00:13:34 +03:00
// Retrieve a service. A slice is returned since we separate Name/Version.
2015-11-08 04:48:48 +03:00
func GetService(name string) ([]*Service, error) {
2015-01-14 02:31:27 +03:00
return DefaultRegistry.GetService(name)
}
2016-01-31 00:13:34 +03:00
// List the services. Only returns service names
func ListServices() ([]*Service, error) {
return DefaultRegistry.ListServices()
}
2015-12-05 04:12:29 +03:00
2016-01-31 00:13:34 +03:00
// Watch returns a watcher which allows you to track updates to the registry.
2018-02-19 20:12:37 +03:00
func Watch(opts ...WatchOption) (Watcher, error) {
return DefaultRegistry.Watch(opts...)
2015-12-05 04:12:29 +03:00
}
2015-12-20 00:56:14 +03:00
func String() string {
return DefaultRegistry.String()
}