election

README

election

Overview

election is a project that simulates various leader election algorithms in distributed systems. This project's primary use is for educational purposes.

Visual implementation located here: https://recover-e.herokuapp.com

To install

go get github.com/LostLaser/election

Algorithms currently implemented

• Bully election
• Ring election

Contributing

Want to improve the project? Open an issue and list what you would like to change/add so we can discuss it.

Retrieving the source

git clone https://github.com/LostLaser/election
cd election
go test -v

Documentation

Index

• type Cluster
  • func New(processSetup server.Setup, serverCount int, heartbeatPause time.Duration, ...) *Cluster
  • func (c Cluster) MarshalJSON() ([]byte, error)
  • func (c Cluster) Purge()
  • func (c Cluster) ReadEvent() interface{}
  • func (c Cluster) ServerIds() []string
  • func (c Cluster) StartServer(id string) error
  • func (c Cluster) StopServer(id string) error
  • func (c Cluster) String() string

Types

type Cluster

type Cluster struct {
	ID string
	// contains filtered or unexported fields
}

Cluster is a linked collection of servers

func New

func New(processSetup server.Setup, serverCount int, heartbeatPause time.Duration, logger *zap.Logger) *Cluster

New will create a cluster with the specified number of servers

func (Cluster) MarshalJSON

func (c Cluster) MarshalJSON() ([]byte, error)

MarshalJSON retrieves the target cluster as a json string

func (Cluster) Purge

func (c Cluster) Purge()

Purge will stop all of the linked servers but not clear their references

func (Cluster) ReadEvent

func (c Cluster) ReadEvent() interface{}

ReadEvent will retrieve a single event log of the servers' actions

func (Cluster) ServerIds

func (c Cluster) ServerIds() []string

ServerIds returns all server ids in the cluster

func (Cluster) StartServer

func (c Cluster) StartServer(id string) error

StartServer starts the server with the specified id in the cluster

func (Cluster) StopServer

func (c Cluster) StopServer(id string) error

StopServer stops the server with the specified id in the cluster

func (Cluster) String

func (c Cluster) String() string

String gets the string representation of the target cluster