gxetcd

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(name string, endpoints []string, timeout time.Duration, heartbeat int) (*Client, error)
  • func NewConfigClient(opts ...Option) *Client
  • func NewConfigClientWithErr(opts ...Option) (*Client, error)
  • func (c *Client) BatchCreate(kList []string, vList []string) error
  • func (c *Client) CleanKV() error
  • func (c *Client) Close()
  • func (c *Client) Create(k string, v string) error
  • func (c *Client) Delete(k string) error
  • func (c *Client) Done() <-chan struct{}
  • func (c *Client) Get(k string) (string, error)
  • func (c *Client) GetChildren(k string) ([]string, []string, error)
  • func (c *Client) GetChildrenKVList(k string) ([]string, []string, error)
  • func (c *Client) GetCtx() context.Context
  • func (c *Client) GetEndPoints() []string
  • func (c *Client) GetRawClient() *clientv3.Client
  • func (c *Client) GetValAndRev(k string) (string, int64, error)
  • func (c *Client) RegisterTemp(k, v string) error
  • func (c *Client) Update(k, v string) error
  • func (c *Client) UpdateWithRev(k, v string, rev int64, opts ...clientv3.OpOption) error
  • func (c *Client) Valid() bool
  • func (c *Client) Watch(k string) (clientv3.WatchChan, error)
  • func (c *Client) WatchWithOption(k string, opts ...clientv3.OpOption) (clientv3.WatchChan, error)
  • func (c *Client) WatchWithPrefix(prefix string) (clientv3.WatchChan, error)
• type Option
  • func WithEndpoints(endpoints ...string) Option
  • func WithHeartbeat(heartbeat int) Option
  • func WithName(name string) Option
  • func WithTimeout(timeout time.Duration) Option
• type Options

Constants

const (
	// ConnDelay connection delay
	ConnDelay = 3
	// MaxFailTimes max failure times
	MaxFailTimes = 15
	// RegistryETCDV3Client client Name
	RegistryETCDV3Client = "etcd registry"
	// MetadataETCDV3Client client Name
	MetadataETCDV3Client = "etcd metadata"
)

Variables

var (
	// ErrNilETCDV3Client raw client nil
	ErrNilETCDV3Client = perrors.New("etcd raw client is nil") // full describe the ERR
	// ErrKVPairNotFound not found key
	ErrKVPairNotFound = perrors.New("k/v pair not found")
	// ErrKVListSizeIllegal k/v list empty or not equal size
	ErrKVListSizeIllegal = perrors.New("k/v List is empty or kList's size is not equal to the size of vList")
	// ErrCompareFail txn compare fail
	ErrCompareFail = perrors.New("txn compare fail")
	// ErrRevision revision when error
	ErrRevision int64 = -1
)

Types

type Client

type Client struct {
	Wait sync.WaitGroup
	// contains filtered or unexported fields
}

Client represents etcd client Configuration

func NewClient

func NewClient(name string, endpoints []string, timeout time.Duration, heartbeat int) (*Client, error)

NewClient create a client instance with name, endpoints etc.

func NewConfigClient

func NewConfigClient(opts ...Option) *Client

NewConfigClient create new Client

func NewConfigClientWithErr

func NewConfigClientWithErr(opts ...Option) (*Client, error)

NewConfigClientWithErr create new Client,error

func (*Client) BatchCreate

func (c *Client) BatchCreate(kList []string, vList []string) error

BatchCreate bulk insertion

func (*Client) CleanKV

func (c *Client) CleanKV() error

CleanKV delete all key and value

func (*Client) Close

func (c *Client) Close()

Close close client

func (*Client) Create

func (c *Client) Create(k string, v string) error

Create key value ...

func (*Client) Delete

func (c *Client) Delete(k string) error

Delete key

func (*Client) Done

func (c *Client) Done() <-chan struct{}

Done return exit chan

func (*Client) Get

func (c *Client) Get(k string) (string, error)

Get gets value by @k

func (*Client) GetChildren

func (c *Client) GetChildren(k string) ([]string, []string, error)

GetChildren return node children

func (*Client) GetChildrenKVList

func (c *Client) GetChildrenKVList(k string) ([]string, []string, error)

GetChildrenKVList gets children kv list by @k

func (*Client) GetCtx

func (c *Client) GetCtx() context.Context

GetCtx return client context

func (*Client) GetEndPoints

func (c *Client) GetEndPoints() []string

GetEndPoints return etcd endpoints

func (*Client) GetRawClient

func (c *Client) GetRawClient() *clientv3.Client

GetRawClient return etcd raw client

func (*Client) GetValAndRev

func (c *Client) GetValAndRev(k string) (string, int64, error)

GetValAndRev gets value and revision by @k

func (*Client) RegisterTemp

func (c *Client) RegisterTemp(k, v string) error

RegisterTemp registers a temporary node

func (*Client) Update

func (c *Client) Update(k, v string) error

Update key value ...

func (*Client) UpdateWithRev

func (c *Client) UpdateWithRev(k, v string, rev int64, opts ...clientv3.OpOption) error

Update key value ...

func (*Client) Valid

func (c *Client) Valid() bool

Valid check client

func (*Client) Watch

func (c *Client) Watch(k string) (clientv3.WatchChan, error)

Watch watches on spec key

func (*Client) WatchWithOption

func (c *Client) WatchWithOption(k string, opts ...clientv3.OpOption) (clientv3.WatchChan, error)

Watch watches on spc key with OpOption

func (*Client) WatchWithPrefix

func (c *Client) WatchWithPrefix(prefix string) (clientv3.WatchChan, error)

WatchWithPrefix watches on spec prefix

type Option

type Option func(*Options)

Option will define a function of handling Options

func WithEndpoints

func WithEndpoints(endpoints ...string) Option

WithEndpoints sets etcd client endpoints

func WithHeartbeat

func WithHeartbeat(heartbeat int) Option

WithHeartbeat sets etcd client heartbeat

func WithName

func WithName(name string) Option

WithName sets etcd client name

func WithTimeout

func WithTimeout(timeout time.Duration) Option

WithTimeout sets etcd client timeout

type Options

type Options struct {
	// Name etcd server name
	Name string
	// Endpoints etcd endpoints
	Endpoints []string
	// Client etcd client
	Client *Client
	// Timeout timeout
	Timeout time.Duration
	// Heartbeat second
	Heartbeat int
}

Options client configuration