kuilt-cluster/us.tractat.kuilt.cluster

Package-level declarations

Types

class ClusterClient

A Raft learner-client that proposes commands through the cluster leader and exposes the committed log stream for state-machine application.

ClusterEndpoints

data class ClusterEndpoints(val endpoints: List<Tag>, val selector: EndpointSelector = RoundRobinEndpointSelector(startIndex = 0))

Configuration for a ClusterClient's endpoint rotation on transport tear.

ManagedRaftTransport

class ManagedRaftTransport(scope: CoroutineScope, val selfId: NodeId) : RaftTransport

A RaftTransport whose backing Seam can be replaced on transport tear without recreating the us.tractat.kuilt.raft.RaftNode.

class VoterMesh

An M-voter Raft mesh — a complete-graph (K_M) cluster of voter RaftNodes.

Functions

fun CoroutineScope.clusterClient(loom: Loom, clusterEndpoints: ClusterEndpoints, clientNodeId: NodeId, clusterConfig: ClusterConfig, raftConfig: RaftConfig, identity: ClientIdentity = ClientIdentity.Auto, clock: () -> Instant): ClusterClient

Constructs a ClusterClient connected to the relay-room cluster.

clusterClientWithNode

fun clusterClientWithNode(raftNode: RaftNode): ClusterClient

Constructs a ClusterClient wrapping raftNode directly.

voterMeshFromNodes

fun voterMeshFromNodes(voterNodes: Map<NodeId, RaftNode>, scope: CoroutineScope): VoterMesh

Construct a VoterMesh from pre-built voter nodes.