memlist

type Config struct {
	// A Name for the Node that is unique to the entire cluster.
	Name string

	// Configuration related to which address and Port the Node will
	// bind to and listen on.
	BindAddr string
	BindPort uint16

	// PingInterval is the time between attempts at random pings towards
	// another Node. Decreasing the interval will result in more frequent
	// checks at the cost of increased bandwidth usage.
	PingInterval time.Duration
	// PingTimeout is the timeout a Node will wait for an ACK response from
	// any member before determining that the Node is potentially unhealthy.
	PingTimeout time.Duration

	// PiggyBackLimit is used as the maximum number of gossip events that are added
	// (piggyback) off of a Node's ping/ack messages.
	//
	// Consider a slider when determining the limit. The lower the limit the smaller
	// the messages and latency will decrease; however, gossip events will take
	// longer to disseminate. Opposite, when increasing the limit, messages will
	// be larger and latency increases while gossip will spread exponentially faster.
	//
	// DefaultLocalConfig chooses 4 as an arbitrary limit.
	PiggyBackLimit int

	// IndirectChecks is the number of nodes that will be contacted in the case
	// that an indirect sendPing is required. Increasing the number of checks will
	// also increase the chances of an indirect sendPing succeeding. This is at the
	// expense of bandwidth usage.
	IndirectChecks int

	// Transport is an optional field for the client to define custom
	// communication among other nodes. If this field is left nil, Create will
	// by default use a NetTransport in the Member.
	Transport Transport

	// TCPTimeout is the time in which a TCP connection will be attempted. If no
	// connection is made before reaching the timeout, then the attempt will fail.
	TCPTimeout time.Duration

	// EventListener can be used to inject the client's implementation of the Listener.
	// If nothing is injected, then Create will use a fake listener in its place.
	EventListener Listener
}

type Gossip struct {
	Gt gossipType

	// Node is the peer that the Gossip refers to.
	Node Node
}

type Listener interface {
	// OnMembershipChange is called when there is a change in the state of a
	// peer or if a peer has joined/left the cluster.
	OnMembershipChange(peer Node)
}

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

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

type Node struct {
	Name  string
	Addr  string
	Port  uint16
	State StateType
	Data  any
}

type Packet struct {
	// Buf is the raw content of the payload.
	Buf []byte

	// From exposes the peer's (sender) address.
	From net.Addr
}

type StateType int

type Transport interface {
	// SendTo will forward the provided byte payload to the given address.
	// This message is expected to be done in a connectionless manner, meaning
	// a response is not guaranteed when the method returns.
	SendTo(b []byte, addr string) error

	// DialAndConnect will create a connection to another peer allowing for a
	// direct two-way connection between both peers.
	DialAndConnect(addr string, timeout time.Duration) (net.Conn, error)

	// Packets returns a channel that is used to receive incoming packets
	// from other peers.
	Packets() <-chan *Packet

	// Stream returns a read only channel that is used to receive incoming
	// streamCh connections from other peers. A streamCh is usually sent during
	// attempts at syncing state between two peers.
	Stream() <-chan net.Conn

	// Shutdown allows for the transport to clean up all listeners safely.
	Shutdown() error
}