election

package module

v1.1.0 Latest Latest Go to latest Published: Jun 22, 2020 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/uol/election

README ¶

election

A Go library to manage a cluster using Zookeeper.

Documentation ¶

Index ¶

Constants
type Cluster
type Config
type Manager
- func New(config *Config) (*Manager, error)

Constants ¶

View Source

const ClusterChanged = 3

ClusterChanged - signals for cluster change

View Source

const Disconnected = 4

Disconnected - int signal for disconnection

View Source

const (
	// EventDisconnected - specifies a custom event for disconnection
	EventDisconnected zk.EventType = 99
)

View Source

const Master = 1

Master - signals for master role acquisition

View Source

const Slave = 2

Slave - signals for slave role acquisition

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Cluster ¶

type Cluster struct {
	IsMaster bool
	Master   string
	Slaves   []string
	Nodes    []string
	NumNodes int
}

Cluster - has cluster info

type Config ¶

type Config struct {
	ZKURL                  []string       `json:"zkURL"`
	ZKElectionNodeURI      string         `json:"zkElectionNodeURI"`
	ZKSlaveNodesURI        string         `json:"zkSlaveNodesURI"`
	ReconnectionTimeout    funks.Duration `json:"reconnectionTimeout"`
	SessionTimeout         funks.Duration `json:"sessionTimeout"`
	ClusterChangeCheckTime funks.Duration `json:"clusterChangeCheckTime"`
	ClusterChangeWaitTime  funks.Duration `json:"clusterChangeWaitTime"`
}

Config - configures the election

type Manager ¶

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

Manager - handles the zookeeper election

func New ¶

func New(config *Config) (*Manager, error)

New - creates a new instance

func (*Manager) Disconnect ¶

func (m *Manager) Disconnect()

Disconnect - disconnects from the zookeeper

func (*Manager) GetClusterInfo ¶

func (m *Manager) GetClusterInfo() (*Cluster, error)

GetClusterInfo - return cluster info

func (*Manager) GetHostname ¶

func (m *Manager) GetHostname() (string, error)

GetHostname - retrieves this node hostname from the OS

func (*Manager) IsMaster ¶

func (m *Manager) IsMaster() bool

IsMaster - check if the cluster is the master

func (*Manager) Start ¶

func (m *Manager) Start() (*chan int, error)

Start - starts to listen zk events

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
tests

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL