discovery

Documentation

Index

• Variables
• type Config
  • func (cfg *Config) Check() *Config
• type Discovery
• type GetOpt
• type GetOpts
• type Result
• type ServiceInstance
• type WatchOpt
• type WatchOpts
• type Watcher

Variables

var ErrWatcherStopped = errors.New("watcher stopped")

ErrWatcherStopped Watcher stopped error when watcher is stopped

Types

type Config

type Config struct {
	RegisterInterval time.Duration          `yaml:"registerInterval"`
	Driver           string                 `json:"driver" yaml:"driver"`
	DriverCfg        map[string]interface{} `json:"driver_config" yaml:"driver_config"`
}

func (*Config) Check

func (cfg *Config) Check() *Config

type Discovery

type Discovery interface {
	String() string
	Watch(ctx context.Context, srv string, opts ...WatchOpt) result.Result[Watcher]
	GetService(ctx context.Context, srv string, opts ...GetOpt) result.Result[[]*service.Service]
}

type GetOpt

type GetOpt func(*GetOpts)

type GetOpts

type GetOpts struct {
	Timeout time.Duration
}

type Result

type Result struct {
	Action  eventpbv1.EventType
	Service *service.Service
}

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

type ServiceInstance

type ServiceInstance struct {
	// ID is the unique instance ID as registered.
	ID string `json:"id"`
	// Name is the service name as registered.
	Name string `json:"name"`
	// Version is the version of the compiled.
	Version string `json:"version"`
	// Metadata is the kv pair metadata associated with the service instance.
	Metadata map[string]string `json:"metadata"`
	// Endpoints are endpoint addresses of the service instance.
	// schema:
	//   http://127.0.0.1:8000?isSecure=false
	//   grpc://127.0.0.1:9000?isSecure=false
	Endpoints []string `json:"endpoints"`
}

ServiceInstance is an instance of a service in a discovery system.

type WatchOpt

type WatchOpt func(*WatchOpts)

type WatchOpts

type WatchOpts struct {
	Service string
}

type Watcher

type Watcher interface {
	// Next is a blocking call
	Next() result.Result[*Result]
	Stop() error
}

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