paxos

README

paxos

It is the Paxos Consensus algorithm Paxos implement in Golang.

Inspired By:

• https://github.com/xiang90/paxos
• https://github.com/kr/paxos

Project52

It is one of my project 52.

License

This package is licensed under MIT license. See LICENSE for details.

Documentation

Overview

Package Paxos is a implement for consensus protocol algorithm "Paxos". The interface of this package is experimental and may change.

There are three role play in this algorithm: "Acceptor", "Proposer" and "Learner".

Index

• Constants
• func CreateNetwork(nodes ...int) *network
• func NewAcceptor(id int, nt nodeNetwork, learners ...int) acceptor
• func NewLearner(id int, nt nodeNetwork, acceptorIDs ...int) *learner
• func NewProposer(id int, val string, nt nodeNetwork, accetors ...int) *proposer

Constants

const (
	Prepare msgType = iota + 1 // Send from proposer -> acceptor
	Promise                    // Send from acceptor -> proposer
	Propose                    // Send from proposer -> acceptor
	Accept                     // Send from acceptor -> learner
)

Functions

func CreateNetwork

func CreateNetwork(nodes ...int) *network

func NewAcceptor

func NewAcceptor(id int, nt nodeNetwork, learners ...int) acceptor

Create a accetor and also assign learning IDs into acceptor. Acceptor: Will response request from proposer, promise the first and largest seq number propose.

After proposer reach the majority promise.  Acceptor will pass the proposal value to learner to confirn and choose.

func NewLearner

func NewLearner(id int, nt nodeNetwork, acceptorIDs ...int) *learner

Initilize learner and prepare message pool.

func NewProposer

func NewProposer(id int, val string, nt nodeNetwork, accetors ...int) *proposer