etcd

Documentation

Index

• Constants
• type Config
• type Leader
  • func NewLeader(e *clientv3.Client, l logrus.FieldLogger, serviceID string, ...) *Leader
  • func (lead *Leader) Acquire() error
  • func (lead *Leader) Close() error
  • func (lead *Leader) IsLeader() bool
  • func (lead *Leader) Resign() error
• type LeaderOption
  • func WithElectionKey(key string) LeaderOption
  • func WithElectionPrefix(prefix string) LeaderOption
• type Plugin
  • func New() *Plugin
  • func (p *Plugin) Boot(conf interface{}, dependencies ...interface{}) plugins.Plugin
  • func (p *Plugin) Close() error
  • func (p *Plugin) Etcd() *clientv3.Client
  • func (p *Plugin) IsEnabled() bool
  • func (p *Plugin) Leader(opts ...LeaderOption) *Leader
  • func (p *Plugin) Lock(key string, do func() error) error
  • func (p *Plugin) LockWithContext(ctx context.Context, key string, do func() error) error
  • func (p *Plugin) LockWithTTL(key string, ttl time.Duration, do func() error) error
  • func (p *Plugin) Name() string
  • func (p *Plugin) Start() error

Constants

const Name = "etcd"

Types

type Config

type Config struct {
	Enable      bool          `env:"ETCD_ENABLE" default:"false" yaml:"enable"`
	Endpoints   string        `env:"ETCD_ENDPOINTS" default:"localhost:2379" yaml:"host"`
	DialTimeout time.Duration `env:"ETCD_DIAL_TIMEOUT" default:"5m" yaml:"dialTimeout"`
}

type Leader

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

func NewLeader

func NewLeader(e *clientv3.Client, l logrus.FieldLogger, serviceID string, opts ...LeaderOption) *Leader

func (*Leader) Acquire

func (lead *Leader) Acquire() error

func (*Leader) Close

func (lead *Leader) Close() error

func (*Leader) IsLeader

func (lead *Leader) IsLeader() bool

func (*Leader) Resign

func (lead *Leader) Resign() error

type LeaderOption

type LeaderOption func(lead *Leader) error

func WithElectionKey

func WithElectionKey(key string) LeaderOption

func WithElectionPrefix

func WithElectionPrefix(prefix string) LeaderOption

type Plugin

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

func New

func New() *Plugin

func (*Plugin) Boot

func (p *Plugin) Boot(conf interface{}, dependencies ...interface{}) plugins.Plugin

func (*Plugin) Close

func (p *Plugin) Close() error

func (*Plugin) Etcd

func (p *Plugin) Etcd() *clientv3.Client

func (*Plugin) IsEnabled

func (p *Plugin) IsEnabled() bool

func (*Plugin) Leader

func (p *Plugin) Leader(opts ...LeaderOption) *Leader

func (*Plugin) Lock

func (p *Plugin) Lock(key string, do func() error) error

func (*Plugin) LockWithContext

func (p *Plugin) LockWithContext(ctx context.Context, key string, do func() error) error

func (*Plugin) LockWithTTL

func (p *Plugin) LockWithTTL(key string, ttl time.Duration, do func() error) error

func (*Plugin) Name

func (p *Plugin) Name() string

func (*Plugin) Start

func (p *Plugin) Start() error