types

type ClusterDomainState string

type ClusterDomainsActiveMap map[string]ClusterDomainState

type ClusterDomainsQuorumMembersMap map[string]int

type GossipIntervals struct {
	// GossipInterval is the time interval within which the nodes gossip
	GossipInterval time.Duration
	// PushPullInterval is the time interval for full local state tcp sync amongst nodes
	PushPullInterval time.Duration
	// ProbeInterval is the time interval for probing other nodes.
	// Used for failure detection amongst peers and reap dead nodes.
	// It is also the interval for broadcasts (Broadcasts Not used currently)
	ProbeInterval time.Duration
	// ProbeTimeout used to determine if a node is down. Should be atleast twice the RTT of network
	ProbeTimeout time.Duration
	// QuorumTimeout is the timeout for which a node will stay in the SUSPECT_NOT_IN_QUORUM
	// and then transition to NOT_IN_QUORUM (Not UP) if quorum is not satisfied
	QuorumTimeout time.Duration
	// SuspicionMult is the multiplier for determining the time an
	// inaccessible node is considered suspect before declaring it dead.
	SuspicionMult int
}

type GossipNodeConfiguration struct {
	// KnownUrl is the ip of this peer node
	KnownUrl string
	// ClusterDomain is the failure domain of this peer node
	ClusterDomain string
}

type GossipStartConfiguration struct {
	// Nodes is a map of known nodes and their failure domains
	Nodes map[NodeId]GossipNodeConfiguration
	// ActiveMap is a map of failure domains to a boolean indicating whether they
	// are active or inactive
	ActiveMap ClusterDomainsActiveMap
	// QuorumProviderType indicates which quorum calculation algorithm to use
	QuorumProviderType QuorumProvider
}

type MessageChannel interface {
	// SendData serialized the the message and sends it
	// to peer. The data must implement json.Marshal
	SendData(obj interface{}) error
	// RcvData recieves data from the peer and unmarshals
	// it into the given obj. obj must be a pointer to
	// effect change and must implement json.Unmarshal
	RcvData(obj interface{}) error
	// RunOnRcvData loops in continously and runs a handler
	// which is activated on receiving any data
	RunOnRcvData(time.Duration)
	// Close terminates the message channel.
	Close()
}

type NodeId string

type NodeInfo struct {
	// Id of the node
	Id NodeId
	// GenNumber of the object
	GenNumber uint64
	// LastUpdateTs is the last updated timestamp for this object
	LastUpdateTs time.Time
	// WaitForGenUpdateTs
	WaitForGenUpdateTs time.Time
	// Status of the node as seen by gossip on this node
	Status NodeStatus
	// Value is the opaque key value map provided by the callers of gossip
	Value StoreMap
	// QuorumMember indicates if this node participates in quorum calculations
	QuorumMember bool
	// ClusterDomain indicates the cluster domain in which this node lies
	ClusterDomain string
	// Addr is the connection address for this node
	Addr string
}

type NodeInfoMap map[NodeId]NodeInfo

type NodeMetaInfo struct {
	// ClusterId of the gossip cluster
	ClusterId string
	// GossipVersion is the version of gossip protocol
	GossipVersion string
	// Id is the node id
	Id NodeId
	// GenNumber of the object
	GenNumber uint64
	// LastUpdateTs is the last updated timestamp for this object
	LastUpdateTs time.Time
}

type NodeStatus uint8

type NodeUpdate struct {
	// Addr is the contact address for the node
	Addr string
	// QuorumMember is true if node participates in quorum decisions
	QuorumMember bool
	// ClusterDomain of the node
	ClusterDomain string
}

type NodeValue struct {
	Id           NodeId
	GenNumber    uint64
	LastUpdateTs time.Time
	Status       NodeStatus
	Value        interface{}
}

type NodeValueMap map[NodeId]NodeValue

type OnMessageRcv func(peerid string, c MessageChannel)

type QuorumProvider uint8

type StateEvent uint8

type StoreKey string

type StoreMap map[StoreKey]interface{}

type StoreMetaInfo map[NodeId]NodeMetaInfo

type StoreNodes []NodeId