paxos

Documentation

Index

• Constants
• type Client
  • func NewClient(id paxi.ID) *Client
  • func (c *Client) Get(key paxi.Key) (paxi.Value, error)
  • func (c *Client) Put(key paxi.Key, value paxi.Value) error
• type CommandBallot
  • func (cb CommandBallot) String() string
• type P1a
  • func (m P1a) String() string
• type P1b
  • func (m P1b) String() string
• type P2a
  • func (m P2a) String() string
• type P2b
  • func (m P2b) String() string
• type P3
  • func (m P3) String() string
• type Paxos
  • func NewPaxos(n paxi.Node, options ...func(*Paxos)) *Paxos
  • func (p *Paxos) Ballot() paxi.Ballot
  • func (p *Paxos) HandleP1a(m P1a)
  • func (p *Paxos) HandleP1b(m P1b)
  • func (p *Paxos) HandleP2a(m P2a)
  • func (p *Paxos) HandleP2b(m P2b)
  • func (p *Paxos) HandleP3(m P3)
  • func (p *Paxos) HandleRequest(r paxi.Request)
  • func (p *Paxos) IsLeader() bool
  • func (p *Paxos) Leader() paxi.ID
  • func (p *Paxos) P1a()
  • func (p *Paxos) P2a(r *paxi.Request)
  • func (p *Paxos) SetActive(active bool)
  • func (p *Paxos) SetBallot(b paxi.Ballot)
• type Replica
  • func NewReplica(id paxi.ID) *Replica

Constants

const (
	HTTPHeaderSlot       = "Slot"
	HTTPHeaderBallot     = "Ballot"
	HTTPHeaderExecute    = "Execute"
	HTTPHeaderInProgress = "Inprogress"
)

Types

type Client

type Client struct {
	*paxi.HTTPClient
	// contains filtered or unexported fields
}

Client overwrites read operation for Paxos

func NewClient

func NewClient(id paxi.ID) *Client

func (*Client) Get

func (c *Client) Get(key paxi.Key) (paxi.Value, error)

Get implements paxi.Client interface there are three reading modes: (1) read as normal command (2) read from leader with current ballot number (3) read from quorum of replicas with barrier

func (*Client) Put

func (c *Client) Put(key paxi.Key, value paxi.Value) error

type CommandBallot

type CommandBallot struct {
	Command paxi.Command
	Ballot  paxi.Ballot
}

CommandBallot conbines each command with its ballot number

func (CommandBallot) String

func (cb CommandBallot) String() string

type P1a

type P1a struct {
	Ballot paxi.Ballot
}

P1a prepare message

func (P1a) String

func (m P1a) String() string

type P1b

type P1b struct {
	Ballot paxi.Ballot
	ID     paxi.ID               // from node id
	Log    map[int]CommandBallot // uncommitted logs
}

P1b promise message

func (P1b) String

func (m P1b) String() string

type P2a

type P2a struct {
	Ballot  paxi.Ballot
	Slot    int
	Command paxi.Command
}

P2a accept message

func (P2a) String

func (m P2a) String() string

type P2b

type P2b struct {
	Ballot paxi.Ballot
	ID     paxi.ID // from node id
	Slot   int
}

P2b accepted message

func (P2b) String

func (m P2b) String() string

type P3

type P3 struct {
	Ballot  paxi.Ballot
	Slot    int
	Command paxi.Command
}

P3 commit message

func (P3) String

func (m P3) String() string

type Paxos

type Paxos struct {
	paxi.Node

	Q1              func(*paxi.Quorum) bool
	Q2              func(*paxi.Quorum) bool
	ReplyWhenCommit bool
	// contains filtered or unexported fields
}

Paxos instance

func NewPaxos

func NewPaxos(n paxi.Node, options ...func(*Paxos)) *Paxos

NewPaxos creates new paxos instance

func (*Paxos) Ballot

func (p *Paxos) Ballot() paxi.Ballot

Ballot returns current ballot

func (*Paxos) HandleP1a

func (p *Paxos) HandleP1a(m P1a)

HandleP1a handles P1a message

func (*Paxos) HandleP1b

func (p *Paxos) HandleP1b(m P1b)

HandleP1b handles P1b message

func (*Paxos) HandleP2a

func (p *Paxos) HandleP2a(m P2a)

HandleP2a handles P2a message

func (*Paxos) HandleP2b

func (p *Paxos) HandleP2b(m P2b)

HandleP2b handles P2b message

func (*Paxos) HandleP3

func (p *Paxos) HandleP3(m P3)

HandleP3 handles phase 3 commit message

func (*Paxos) HandleRequest

func (p *Paxos) HandleRequest(r paxi.Request)

HandleRequest handles request and start phase 1 or phase 2

func (*Paxos) IsLeader

func (p *Paxos) IsLeader() bool

IsLeader indecates if this node is current leader

func (*Paxos) Leader

func (p *Paxos) Leader() paxi.ID

Leader returns leader id of the current ballot

func (*Paxos) P1a

func (p *Paxos) P1a()

P1a starts phase 1 prepare

func (*Paxos) P2a

func (p *Paxos) P2a(r *paxi.Request)

P2a starts phase 2 accept

func (*Paxos) SetActive

func (p *Paxos) SetActive(active bool)

SetActive sets current paxos instance as active leader

func (*Paxos) SetBallot

func (p *Paxos) SetBallot(b paxi.Ballot)

SetBallot sets a new ballot number

type Replica

type Replica struct {
	paxi.Node
	*Paxos
}

Replica for one Paxos instance

func NewReplica

func NewReplica(id paxi.ID) *Replica

NewReplica generates new Paxos replica