cluster

Documentation

Overview

Package cluster implements a gossip-based cluster based on HashiCorp memberlist.

Index

• type Config
• type Peer
  • func NewPeer(config Config) (*Peer, error)
  • func (p *Peer) Leave(timeout time.Duration) error
  • func (p *Peer) Query(f func(peerType string) bool) (apiHostPorts []string)

Types

type Config

type Config struct {
	ClusterHost   string
	ClusterPort   int
	AdvertiseHost string // optional; by default, ClusterHost is used
	AdvertisePort int    // optional; by default, ClusterPort is used
	APIHost       string
	APIPort       int
	Type          string
	InitialPeers  []string
	Logger        log.Logger
}

Config for our node in the cluster. All fields are mandatory unless otherwise noted.

type Peer

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

Peer models a node in the cluster.

func NewPeer

func NewPeer(config Config) (*Peer, error)

NewPeer joins the cluster. Don't forget to leave it, at some point.

func (*Peer) Leave

func (p *Peer) Leave(timeout time.Duration) error

Leave the cluster, waiting up to timeout for a confirmation.

func (*Peer) Query

func (p *Peer) Query(f func(peerType string) bool) (apiHostPorts []string)

Query for other peers in the cluster whose type passes the function f. Results are returned as matching API host:port pairs.