cluster

package

v0.0.0-...-724c7a8 Latest Latest Go to latest Published: Feb 2, 2022 License: EUPL-1.2 Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	RetainSnapshotCount = 2
	RaftTimeout         = 10 * time.Second
)

View Source

const (
	LeadershipPollInterval = time.Duration(500 * time.Millisecond)
)

This section is empty.

This section is empty.

type Address struct {
	Host string `json:"host,omitempty" yaml:"host,omitempty"`
	Port int    `json:"port,omitempty" yaml:"port,omitempty"`
}

func (a Address) String() string

func (a *Address) UnmarshalFlag(value string) error

type Cluster struct {
	// contains filtered or unexported fields
}

func New(id string, context *distributed.Context, options ...Option) (*Cluster, error)

func (c *Cluster) MonitorClusterEvents(ctx context.Context) <-chan NodeState

func (c *Cluster) StartRPCServer() error

func (c *Cluster) StopRPCServer()

type NodeState uint8

const (
	Initial NodeState = iota
	Leader
	Follower
	Exiting
)

type Option func(*Cluster)

Option is the type for functional options.

func WithBootstrap(value bool) Option

func WithDirectory(dir string) Option

WithDirectory specifies the directory where the Raft cluster state is stored.

func WithLogger(logger logging.Logger) Option

WithLogger specifies a logger.

func WithNetAddress(address string) Option

WithNetAddress specifies the address used in multiplexing mode both for intra-cluster communications and to expose the gRPC services.

func WithPeer(peer Peer) Option

WithPeer specifies a peer to contact to join the cluster.

func WithPeers(peers ...Peer) Option

WithPeers specifies the peers to contact to join the cluster.

type Peer struct {
	ID      string  `json:"id,omitempty" yaml:"id,omitempty"`
	Address Address `json:"address,omitempty" yaml:"address,omitempty"`
}

func (p Peer) String() string

func (p *Peer) UnmarshalFlag(value string) error