etcd

Documentation

Overview

Package etcd includes etcd clients ops related

Index

• func Connect(addrs ...string) (client.KeysAPI, error)
• func OpenDebug(open bool)
• func ProviderHeartbeat(ctx context.Context, provider ServerProvider, opt *ProvideOptions)
• type ProvideOptions
• type Server
• type ServerProvider
  • func NewProvider(kapi client.KeysAPI, name, addr string) ServerProvider
• type Watcher
  • func NewWatcher(kapi client.KeysAPI, serverPrefix string, d time.Duration) *Watcher
  • func (w *Watcher) AddMember(key, value string)
  • func (w *Watcher) DeleteMember(key string)
  • func (w *Watcher) ExpireMember(key string)
  • func (w *Watcher) RangeMember() []Server
  • func (w *Watcher) Watch()

Functions

func Connect

func Connect(addrs ...string) (client.KeysAPI, error)

Connect to etcd client addr format like: http://host:port

func OpenDebug

func OpenDebug(open bool)

OpenDebug set debug mode on

func ProviderHeartbeat

func ProviderHeartbeat(ctx context.Context,
	provider ServerProvider, opt *ProvideOptions,
)

ProviderHeartbeat ... ref to: http://ralphbupt.github.io/2017/05/04/etcd-%E6%9C%8D%E5%8A%A1%E6%B3%A8%E5%86%8C%E4%B8%8E%E5%8F%91%E7%8E%B0/

Types

type ProvideOptions

type ProvideOptions struct {
	NamePrefix        string             // ServerName Prefix if "" means no prefix
	SetOpts           *client.SetOptions // etcd client SetOptions
	TTLDuration       time.Duration      // ttl time.Duration
	HeartbeatDuration time.Duration      // HeartbeatDuration duration
}

ProvideOptions ...

type Server

type Server struct {
	Name  string `json:"name"`
	Addr  string `json:"addr"`
	Alive bool   `json:"alive"`
}

Server ...

type ServerProvider

type ServerProvider interface {
	Name() string
	Addr() string
	KeysAPI() client.KeysAPI
	// Provide support set key-value to etcd
	Provide(*ProvideOptions) error
	// Quit while should be called while Server quit
	Quit(*ProvideOptions) error
}

ServerProvider ....

func NewProvider

func NewProvider(kapi client.KeysAPI, name, addr string) ServerProvider

NewProvider ...

type Watcher

type Watcher struct {
	sync.RWMutex // RW mutext
	// contains filtered or unexported fields
}

Watcher ... ref to http://daizuozhuo.github.io/etcd-service-discovery/

func NewWatcher

func NewWatcher(
	kapi client.KeysAPI, serverPrefix string, d time.Duration,
) *Watcher

NewWatcher ...

func (*Watcher) AddMember

func (w *Watcher) AddMember(key, value string)

AddMember ...

func (*Watcher) DeleteMember

func (w *Watcher) DeleteMember(key string)

DeleteMember ...

func (*Watcher) ExpireMember

func (w *Watcher) ExpireMember(key string)

ExpireMember ...

func (*Watcher) RangeMember

func (w *Watcher) RangeMember() []Server

RangeMember ...

func (*Watcher) Watch

func (w *Watcher) Watch()

Watch ...