types

Documentation

Index

• type Channel
• type GossipServiceLayer
• type GossipState
• type RaftServiceLayer
• type RaftState
• type ServiceLayer

Types

type Channel

type Channel interface {
	Broadcast(b []byte)
	BroadcastFullState(b []byte)
}

Channel allows clients to send messages for a specific state type that will be broadcasted in a best-effort manner.

type GossipServiceLayer

type GossipServiceLayer interface {
	ServiceLayer
	Leave()
	Members() []*memberlist.Node
	UpdateMeta([]byte)
	Join([]string) error
	AddState(key string, state GossipState) (Channel, error)
}

type GossipState

type GossipState interface {
	Merge(inc []byte, full bool) error
	MarshalBinary() []byte
}

GossipState represents a CRDT state store, that will be distributed over the mesh network.

type RaftServiceLayer

type RaftServiceLayer interface {
	ServiceLayer
	Start(name string, state RaftState) error
	ApplyEvent(event []byte) error
	Shutdown() error
	IsLeader() bool
}

type RaftState

type RaftState interface {
	Apply(event []byte) error
	Snapshot() io.ReadCloser
	Restore(io.Reader) error
}

type ServiceLayer

type ServiceLayer interface {
	pb.LayerServer
	Health() string
}