ScaleCube Cluster is a lightweight decentralized cluster membership, failure detection, and gossip protocol library. It provides an implementation of SWIM cluster membership protocol for Java VM.
It is an efficient and scalable weakly-consistent distributed group membership protocol based on gossip-style communication between the nodes in the cluster. Read blog post with distilled notes on the SWIM paper for more details.
It is using a random-probing failure detection algorithm which provides a uniform expected network load at all members. The worst-case network load is linear O(n) for overall network produced by running algorithm on all nodes and constant network load at one particular member independent from the size of the cluster.
ScaleCube Cluster implements all improvements described at original SWIM algorithm paper, such as gossip-style dissemination, suspicion mechanism and time-bounded strong completeness of failure detector algorithm. In addition to that we have introduced support of additional SYNC mechanism in order to improve recovery of the cluster from network partitioning events.
Using ScaleCube Cluster as simple as few lines of code:
// Start cluster node Alice as a seed node of the cluster, listen and print all incoming messages
Cluster alice = Cluster.joinAwait();
alice.listen().subscribe(msg -> System.out.println("Alice received: " + msg.data()));
// Join cluster node Bob to cluster with Alice, listen and print all incoming messages
Cluster bob = Cluster.joinAwait(alice.address());
bob.listen().subscribe(msg -> System.out.println("Bob received: " + msg.data()));
// Join cluster node Carol to cluster with Alice (and Bob which is resolved via Alice)
Cluster carol = Cluster.joinAwait(alice.address());
// Send from Carol greeting message to all other cluster members (which is Alice and Bob)
carol.otherMembers().forEach(member -> carol.send(member, Message.fromData("Greetings from Carol")));You are welcome to explore javadoc documentation on cluster API and examples module for more advanced use cases.
For improvement requests, bugs and discussions please use the GitHub Issues or chat with us to get support on Gitter.
You are more then welcome to join us or just show your support by granting us a small star :)
Binaries and dependency information for Maven can be found at https://search.maven.org.
To add a dependency on ScaleCube Cluster using Maven, use the following:
<dependency>
<groupId>io.scalecube</groupId>
<artifactId>scalecube-cluster</artifactId>
<version>x.y.z</version>
</dependency>To add a dependency on ScaleCube Transport using Maven, use the following:
<dependency>
<groupId>io.scalecube</groupId>
<artifactId>scalecube-transport</artifactId>
<version>x.y.z</version>
</dependency>- Follow/Star us on github.
- Fork (and then git clone https://github.com/--your-username-here--/scalecube.git).
- Create a branch (git checkout -b branch_name).
- Commit your changes (git commit -am "Description of contribution").
- Push the branch (git push origin branch_name).
- Open a Pull Request.
- Thank you for your contribution! Wait for a response...