routing

type Parameters struct {
	// MaxBucketPeers is the maximum number of peers in a bucket.
	MaxBucketPeers uint
}

type PushStatus int

type Table interface {
	// SelfID returns the table's selfID.
	SelfID() id.ID

	// Push adds the peer into the appropriate bucket and returns an AddStatus result.
	Push(new peer.Peer) PushStatus

	// Find removes and returns the k peers in the bucket(s) closest to the given target.
	Find(target id.ID, k uint) []peer.Peer

	// Get returns the peer with the given ID or nil (if it doesn't exist) with a boolean
	// indicator for whether the peer existed.
	Get(peerID id.ID) (peer.Peer, bool)

	// Sample returns k peers in the table sampled (approximately) uniformly from the ID space.
	// Peers are sampled from buckets with probability proportional to the amount of ID
	// space the bucket covers.
	Sample(k uint, rng *rand.Rand) []peer.Peer

	// NumPeers returns the number of total peers in the routing table.
	NumPeers() int

	// NumBuckets returns the number of buckets in the routing table.
	NumBuckets() int

	// Save saves the table via the NamespaceStorer
	Save(ns storage.Storer) error
}