zkWrap

README

zkWrap

介绍

Wrapper of common Zookeeper high-level tools.

软件架构

软件架构说明

安装教程

1. xxxx
2. xxxx
3. xxxx

使用说明

1. xxxx
2. xxxx
3. xxxx

参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

特技

1. 使用 Readme_XXX.md 来支持不同的语言，例如 Readme_en.md, Readme_zh.md
2. Gitee 官方博客 blog.gitee.com
3. 你可以 https://gitee.com/explore 这个地址来了解 Gitee 上的优秀开源项目
4. GVP 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5. Gitee 官方提供的使用手册 https://gitee.com/help
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 https://gitee.com/gitee-stars/

Documentation

Index

• func Chroot(path string) error
• func CurRoot() string
• type ElectionCallback
• type Elector
  • func NewElector(electionName string, me string, onElectedCallback ElectionCallback) (*Elector, error)
  • func (el *Elector) Resign()
  • func (el *Elector) StopElection()
• type Heartbeat
  • func RegisterHeartbeat(serviceName string, timeout time.Duration, regData string, ...) (*Heartbeat, error)
  • func (hb *Heartbeat) Disconnect()
  • func (hb *Heartbeat) GetMates() []string
• type HeartbeatEventCallback
• type Mutex
  • func NewMutex(lockName string) (*Mutex, error)
  • func (l *Mutex) Lock() error
  • func (l *Mutex) Unlock() error

Functions

func Chroot

func Chroot(path string) error

func CurRoot

func CurRoot() string

Types

type ElectionCallback

type ElectionCallback func(*Elector)

type Elector

type Elector struct {
	IsLeader     bool
	IsRunning    bool
	ElectionName string
	Me           string
	// contains filtered or unexported fields
}

func NewElector

func NewElector(electionName string, me string, onElectedCallback ElectionCallback) (*Elector, error)

func (*Elector) Resign

func (el *Elector) Resign()

func (*Elector) StopElection

func (el *Elector) StopElection()

type Heartbeat

type Heartbeat struct {
	ServiceName string
	// contains filtered or unexported fields
}

func RegisterHeartbeat

func RegisterHeartbeat(serviceName string, timeout time.Duration, regData string,
	onConnectCallback HeartbeatEventCallback, onDisConnectCallback HeartbeatEventCallback) (*Heartbeat, error)

func (*Heartbeat) Disconnect

func (hb *Heartbeat) Disconnect()

func (*Heartbeat) GetMates

func (hb *Heartbeat) GetMates() []string

type HeartbeatEventCallback

type HeartbeatEventCallback func(string, string) // regData, nodeName

type Mutex

type Mutex struct {
	Name string
	// contains filtered or unexported fields
}

func NewMutex

func NewMutex(lockName string) (*Mutex, error)

func (*Mutex) Lock

func (l *Mutex) Lock() error

func (*Mutex) Unlock

func (l *Mutex) Unlock() error