github.com/RaviKumarYadav/Raft_Cluster/Bug


Install
go get github.com/RaviKumarYadav/Raft_Cluster/Bug

Documentation

CLUSTER

cluster.go

cluster.go is the source file which is used to generate cluster.a library file. There are many methods defined in this library which internally implements zmq.

Few methods are described below :-

  • NewServer(serverId int, configFile string) Server
  • It will return a Server object by passing serverId as one of the argument , other details of the Server are stored in configFile . These details can be IP address (alongwith port number)
  • SendMessage(server Server)
    • It will start sending any message (in the format as mentioned in cluster.Envelope) as soon as invoked.
  • ReceiveMessage(server Server)
    • It will start receiving on the mentioned port (in the format as mentioned in cluster.Envelope) as soon as invoked.

Installation

go get github.com/RaviKumarYadav/Raft/cluster
cd .../github.com/RaviKumarYadav/Raft/cluster
go test

How it works

  • Cluster is a group of different Servers working and communicating with each other to form a larger system that will later be used for implementing distributed system.
  • Server uses Messages to communicate with each other . Each server is assigned a unique ServerId which helps in identifying any Server in the System/Cluster.
  • Message being exchanged also have a structure which contains :-
  • MessageId
    • Its unique for each Message.
  • Pid
    • It reflects the target server or the recipient server for the message.
  • MsgType
    • Messages can be of different types like :-
      • AppendEntriesRequest
      • AppendEntriesResponse
      • RequestVoteRequest
      • RequestVoteResponse
  • SenderId
    • ServerId of the sending server.
  • Term
    • Term of the Server sending the message.
  • Voted
    • Voting Status of the Server for the said term.

To run individually just pass "ServerId" as command line argument eg :- go run mainFile.go 1 , where "1" is the ServerId whose other details are present in configFile which will be fetched by the program.

Test Cases

There are few cases present in file "Raft/cluster/cluster_test.go". It tests for following :-

  • Unicast
    • Peer-Peer messages sent by one server to another (by each server in cluster)
  • Multicast
    • Messages sent by each server is listened by each member(server) in the cluster
  • Unicast and Multicast
    • Mix of Unicast and Multicast messages were sent by each server
  • Cyclic Unicast
    • Each server sent messages to another server which next to it (in terms of ServerId)

How to Run Test Cases

cd github.com/RaviKumarYadav/Raft/cluster
go test

License

IIT Bombay