node

package

v0.0.0-...-73ed01f Latest Latest Go to latest Published: Jun 19, 2021 License: MIT Imports: 9 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

The node package implements some main functions the replica has to perform to get started and respond to requests.

It then uses these structs to initialise a new raft node.

The Get, Set and Delete functions are called by the leader in the cluster on corresponding request from the admin
The Join and Leave functions implements the logic for new replicas joining and leaving the replica.

This section is empty.

This section is empty.

This section is empty.

type RavelNode struct {
	Fsm  *fsm.RavelFSM
	Raft *raft.Raft
}

RavelNode represents a node inside the cluster.

func (n *RavelNode) Delete(key []byte) error

Delete deletes the entry with given key

func (n *RavelNode) Get(key []byte) ([]byte, error)

Get returns the value for the given key

func (n *RavelNode) GetAndDelete(key []byte) ([]byte, error)

GetAndDelete returns the value for the given key

func (n *RavelNode) Join(nodeID, raftAddr string) error

Join will join the node available on raftAddr with ID nodeID to this node if its a leader

func (n *RavelNode) Leave(nodeID string) error

Leave removes the node with nodeID from this leader

func (n *RavelNode) Open(enableSingle bool, localID string, badgerPath string, BindAddr string) (*raft.Raft, *fsm.RavelFSM, error)

Open creates initialises a raft.Raft instance

func (n *RavelNode) Set(key []byte, value []byte) error

Set sets the key with the value