Package raftutil provides some convience functionality for building an internal raft cluster that overlays a cluster of nodes.

AllowSingleNode ...

Bootstrap - bootstraps the provided cluster using the options provided.

BootstrapOptionAllowRetry - strategy to use to determine if another attempt should be made at joining the cluster.

BootstrapOptionBackoff - backoff strategy to use.

BootstrapOptionJoinStrategy - strategy to use to determine if a join was successful.

BootstrapOptionPeeringStrategies - set the strategies for peering.

MaximumAttempts ...

MinimumPeers ...

NewCluster ...

NewDialer creates a dialer to connect to the cluster.

NewMock a fake cluster made up of a set of peers and a local node.

NewOptions build default cluster options.

NewOptionsFromConfig ...

NewPending a cluster that hasn't been initialized yet but will be.

NewSingleNode creates a cluster that is made up of just a single node.

NewStatic a static cluster made up of a set of nodes.

OptionAdvertiseAddress specify the address to advertise.

OptionAdvertisePort specify the port to advertise.

OptionAliveDelegate set the event delegate for the cluster.

OptionBindAddress specify the address to bind the cluster to.

OptionBindPort specify the port for the cluster to bind to.

OptionDelegate set the delegate for the cluster.

OptionEventDelegate set the event delegate for the cluster.

OptionKeyring set the keyring for the cluster to encrypt communications.

OptionLogger sets the logger for the memberlist.

OptionLogOutput sets the logger for the memberlist.

OptionNodeID specify the name of the node within the cluster.

OptionTransport provide the transport for the node.

Peers converts the peers into an array of host:port.

Snapshot - performs a periodic snapshot of the cluster.

SnapshotOptionContext specify the context to use for signalling shutdown.

SnapshotOptionFrequency specify how often a snapshot should be taken.

UnlimitedAttempts ...

ErrPeeringOptionsExhausted returned by bootstrap methods when the strategies for peering have been exhausted.

Dialer used to join a cluster.

Memberlist represents the cluster.

Mock a fake cluster made up of a set of peers and a local node.

Options holds the options for the cluster.

Pending set of nodes.

PrintingEventDelegate prints out events to the standard logger.

Static set of nodes.

C interface to a cluster.

cluster is used to extract the peers within a cluster from the underlying implementations.

Rendezvous interface.

Source is used to pull peers from various sources, typically from a snapshot.

BootstrapOption option for bootstrapping a clusters.

DialOption ...

Option interface for specifying a cluster option.

SnapshotOption options for snapshotting.