etcd3

README

etcd

contrib/etcd is a contrib module that provides a grpc registry implementation based on etcd.

Documentation

Index

• func RegisterResolver(etcdConfig clientv3.Config)
• type Driver
  • func (drv *Driver) CreateRegistry(cnf *conf.Configuration) (registry.Registry, error)
  • func (drv *Driver) GetRegistry(name string) (registry.Registry, error)
  • func (drv *Driver) ResolverBuilder(cnf *conf.Configuration) (resolver.Builder, error)
  • func (drv *Driver) WithDialOptions(registry.DialOptions) ([]grpc.DialOption, error)
• type Options
• type Registry
  • func BuildFromConfig(config *Options) (*Registry, error)
  • func New() *Registry
  • func (r *Registry) Apply(cfg *conf.Configuration)
  • func (r *Registry) Close()
  • func (r *Registry) GetServiceInfos(service string) ([]*registry.ServiceInfo, error)
  • func (r *Registry) Register(node *registry.ServiceInfo) error
  • func (r *Registry) TTL() time.Duration
  • func (r *Registry) Unregister(node *registry.ServiceInfo) error

Functions

func RegisterResolver

func RegisterResolver(etcdConfig clientv3.Config)

RegisterResolver register etcdBuilder as the global grpc resolver

Types

type Driver

type Driver struct {
	// contains filtered or unexported fields
}

Driver is an etcd3 registry driver. Support reference config.

func (*Driver) CreateRegistry

func (drv *Driver) CreateRegistry(cnf *conf.Configuration) (registry.Registry, error)

CreateRegistry creates a new registry.

func (*Driver) GetRegistry

func (drv *Driver) GetRegistry(name string) (registry.Registry, error)

GetRegistry gets a registry by name.

only a reference registry can be got.see the config example

func (*Driver) ResolverBuilder

func (drv *Driver) ResolverBuilder(cnf *conf.Configuration) (resolver.Builder, error)

ResolverBuilder creates a new resolver builder.

func (*Driver) WithDialOptions

func (drv *Driver) WithDialOptions(registry.DialOptions) ([]grpc.DialOption, error)

WithDialOptions no need to implement

type Options

type Options struct {
	EtcdConfig clientv3.Config `json:"etcd" yaml:"etcd"`
	TTL        time.Duration   `json:"ttl" yaml:"ttl"`
}

type Registry

type Registry struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Registry is an etcd3 registry for service discovery.

func BuildFromConfig

func BuildFromConfig(config *Options) (*Registry, error)

func New

func New() *Registry

func (*Registry) Apply

func (r *Registry) Apply(cfg *conf.Configuration)

func (*Registry) Close

func (r *Registry) Close()

func (*Registry) GetServiceInfos

func (r *Registry) GetServiceInfos(service string) ([]*registry.ServiceInfo, error)

GetServiceInfos implements registry interface

func (*Registry) Register

func (r *Registry) Register(node *registry.ServiceInfo) error

func (*Registry) TTL

func (r *Registry) TTL() time.Duration

func (*Registry) Unregister

func (r *Registry) Unregister(node *registry.ServiceInfo) error

Unregister remove service from etcd