etcd

Documentation

Overview

Package etcd is registered as a service using etcd.

Index

• func NewRegistry(etcdEndpoints []string, id string, instanceName string, ...) (registry.Registry, *registry.ServiceInstance, error)
• type Option
  • func WithContext(ctx context.Context) Option
  • func WithMaxRetry(num int) Option
  • func WithNamespace(ns string) Option
  • func WithRegisterTTL(ttl time.Duration) Option
• type Registry
  • func New(client *clientv3.Client, opts ...Option) (r *Registry)
  • func (r *Registry) Deregister(ctx context.Context, service *registry.ServiceInstance) error
  • func (r *Registry) GetService(ctx context.Context, name string) ([]*registry.ServiceInstance, error)
  • func (r *Registry) IsServiceRegistered(ctx context.Context, key string) (bool, error)
  • func (r *Registry) Register(ctx context.Context, service *registry.ServiceInstance) error
  • func (r *Registry) Watch(ctx context.Context, name string) (registry.Watcher, error)

Functions

func NewRegistry

func NewRegistry(etcdEndpoints []string, id string, instanceName string, instanceEndpoints []string, opts ...etcdcli.Option) (registry.Registry, *registry.ServiceInstance, error)

NewRegistry instantiating the etcd registry Note: If the etcdcli.WithConfig(*clientv3.Config) parameter is set, the etcdEndpoints parameter is ignored!

Types

type Option

type Option func(o *options)

Option is etcd registry option.

func WithContext

func WithContext(ctx context.Context) Option

WithContext with registry context.

func WithMaxRetry

func WithMaxRetry(num int) Option

WithMaxRetry set max retry times.

func WithNamespace

func WithNamespace(ns string) Option

WithNamespace with registry namespace.

func WithRegisterTTL

func WithRegisterTTL(ttl time.Duration) Option

WithRegisterTTL with register ttl.

type Registry

type Registry struct {
	EtcdClient *clientv3.Client
	// contains filtered or unexported fields
}

Registry is etcd registry.

func New

func New(client *clientv3.Client, opts ...Option) (r *Registry)

New create a etcd registry

func (*Registry) Deregister

func (r *Registry) Deregister(ctx context.Context, service *registry.ServiceInstance) error

Deregister the registration.

func (*Registry) GetService

func (r *Registry) GetService(ctx context.Context, name string) ([]*registry.ServiceInstance, error)

GetService return the service instances in memory according to the service name.

func (*Registry) IsServiceRegistered

func (r *Registry) IsServiceRegistered(ctx context.Context, key string) (bool, error)

IsServiceRegistered 检查给定的服务实例是否已注册。

func (*Registry) Register

func (r *Registry) Register(ctx context.Context, service *registry.ServiceInstance) error

Register the registration.

func (*Registry) Watch

func (r *Registry) Watch(ctx context.Context, name string) (registry.Watcher, error)

Watch creates a watcher according to the service name.