SWIM Cluster Membership API Documentation

Welcome to the API documentation of Swift Cluster Membership’s SWIM implementation!

General overview

Please refer to SWIM documentation for a general discussion and overview of the algorithm.

Custom transport implementations

When considering custom shell implementations, types of most interest are:

• SWIMProtocol which documents the callbacks which are needed to be invoked to drive the algorithm encapsulated in SWIM.Instance,
• and the peer protocols SWIMPeer, SWIMPingOriginPeer, SWIMPingRequestOriginPeer which represent the various roles a peer plays in the protocol.

Reusing existing implementations

For reusing existing implementations please refer to their documentation pages, listed below:

Modules

Other modules

• SWIM
• SWIMNIOExample