micro/register/register.go

85 lines
2.5 KiB
Go
Raw Normal View History

// Package register is an interface for service discovery
package register
2015-01-14 02:31:27 +03:00
2016-02-25 15:42:31 +03:00
import (
"context"
2016-02-25 15:42:31 +03:00
"errors"
"github.com/unistack-org/micro/v3/metadata"
2016-02-25 15:42:31 +03:00
)
const (
// WildcardDomain indicates any domain
WildcardDomain = "*"
// DefaultDomain to use if none was provided in options
DefaultDomain = "micro"
)
var (
// DefaultRegister is the global default register
DefaultRegister Register = NewRegister()
// ErrNotFound returned when LookupService is called and no services found
ErrNotFound = errors.New("service not found")
// ErrWatcherStopped returned when when watcher is stopped
ErrWatcherStopped = errors.New("watcher stopped")
)
// Register provides an interface for service discovery
2016-01-31 00:13:34 +03:00
// and an abstraction over varying implementations
// {consul, etcd, zookeeper, ...}
type Register interface {
Name() string
Init(...Option) error
Options() Options
Connect(context.Context) error
Disconnect(context.Context) error
Register(context.Context, *Service, ...RegisterOption) error
Deregister(context.Context, *Service, ...DeregisterOption) error
LookupService(context.Context, string, ...LookupOption) ([]*Service, error)
ListServices(context.Context, ...ListOption) ([]*Service, error)
Watch(context.Context, ...WatchOption) (Watcher, error)
2015-12-20 00:56:14 +03:00
String() string
}
// Service holds service register info
2020-04-12 12:58:12 +03:00
type Service struct {
Name string `json:"name"`
Version string `json:"version"`
Metadata metadata.Metadata `json:"metadata"`
2020-04-12 12:58:12 +03:00
Endpoints []*Endpoint `json:"endpoints"`
Nodes []*Node `json:"nodes"`
}
// Node holds node register info
2020-04-12 12:58:12 +03:00
type Node struct {
Metadata metadata.Metadata `json:"metadata"`
2020-04-12 12:58:12 +03:00
Id string `json:"id"`
Address string `json:"address"`
}
// Endpoint holds endpoint register info
2020-04-12 12:58:12 +03:00
type Endpoint struct {
Request string `json:"request"`
Response string `json:"response"`
Metadata metadata.Metadata `json:"metadata"`
Name string `json:"name"`
2020-04-12 12:58:12 +03:00
}
// Option func signature
2015-12-19 21:28:08 +03:00
type Option func(*Options)
// RegisterOption option is used to register service
2016-01-27 02:32:27 +03:00
type RegisterOption func(*RegisterOptions)
// WatchOption option is used to watch service changes
2018-02-19 20:12:37 +03:00
type WatchOption func(*WatchOptions)
// DeregisterOption option is used to deregister service
2020-04-14 14:32:59 +03:00
type DeregisterOption func(*DeregisterOptions)
// LookupOption option is used to get service
type LookupOption func(*LookupOptions)
2020-04-14 14:32:59 +03:00
// ListOption option is used to list services
2020-04-14 14:32:59 +03:00
type ListOption func(*ListOptions)