types

type Overlay interface {
	// Create/Bootstrap the overlay in the current node.
	Create(ctx context.Context, thisNode OverlayMembership) error

	// Join an overlay given a participant node IP and the respective port where its overlay daemon is listening.
	Join(ctx context.Context, overlayNodeIP string, overlayNodePort int, thisNode OverlayMembership) error

	// Get a list of remote nodes using a given key.
	Lookup(ctx context.Context, key []byte) ([]*OverlayNode, error)

	// Get a list of the neighbors nodes of the given node.
	Neighbors(ctx context.Context, nodeID []byte) ([]*OverlayNode, error)

	// Unique identifier for the physical node where the overlay is running.
	// The overlay can have virtual nodes here we only want return always one ID that is unique in all nodes.
	NodeID(ctx context.Context) ([]byte, error)

	// Leave the overlay.
	Leave(ctx context.Context) error
}

type OverlayMembership interface {
	// Called when a new local virtual node joins the overlay.
	AddTrader(guid []byte)
}

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