tyler-r / gossip-protocol Goto Github PK

Ensure that there are no race conditions in the protocol. May want to look into ensuring that all the data in the Member class is synchronized and that all the member accesses in the Gossip class are synchronized as well.

Currently logging is done using println statements. This should be changed to a use a logging system, possibly using an interface that can be be set by the user of the library. I think it would be best to set this in a static context on the Gossip class.

There are a number of exception that are being caught, but are either naively having the stack trace printed or not being handled at all. This should be changed so that either corrective action is taken to address why the exception was thrown, or a better log message should be printed using the logging system discussed in issue #5.

To clean up config creation code the Builder design pattern should be used to instantiate the Config class.

The gossip and Member class often take an IPAddress and Port as parameters. This should be changed to use the SocketAddress class as has been done in partially done to reduce the number of parameters that these classes need, especially for constructors.

The heartbeat counter is currently implemented using a long value. It should be changed to a value that can does not overflow and thus can grow infinitely large.

There is a number of int based duration in the Config class that represent time in milliseconds. These should be changed to millisecond duration classes to better represent what the variable represents.

Add a Readme to explain the repository, an overview of the public methods, and give an example of how to use the Gossip protocol class.

Add the MIT license or a similair license to the project