search

type ClosestPeers interface {
	PeerDistanceHeap
}

type FarthestPeers interface {
	PeerDistanceHeap
}

type Parameters struct {
	// NClosestResponses is the required number of peers closest to the key we need to receive
	// responses from
	NClosestResponses uint

	// NMaxErrors is the maximum number of errors tolerated when querying peers during the search
	NMaxErrors uint

	// Concurrency is the number of concurrent queries to use in search
	Concurrency uint

	// Timeout for queries to individual peers
	Timeout time.Duration
}

type PeerDistanceHeap interface {
	heap.Interface

	// SafePush pushes a peer onto the heap and subsequently removes a peer if the number of
	// peers exceeds the capacity. At capacity, these peer removals guarantee that the head
	// always becomes closer to the target or stays the same with each push.
	SafePush(peer.Peer)

	// SafePushMany pushed an array of peers.
	SafePushMany([]peer.Peer)

	// PeakDistance returns the distance from the root of the heap to the target.
	PeakDistance() *big.Int

	// PeakPeer returns (but does not remove) the the root of the heap.
	PeakPeer() peer.Peer

	// ToAPI creates an array of api.PeerAddresses from the peers in the heap.
	ToAPI() []*api.PeerAddress

	// Peers returns the ordered peers in the heap, starting from the top.
	Peers() []peer.Peer

	// In returns whether a peer ID is in the heap
	In(id.ID) bool

	// Distance returns the distance from a peer to the target.
	Distance(peer.Peer) *big.Int

	// Capacity return the maximum number of peers allowed in the heap.
	Capacity() int
}

type QueryQueue struct {
	Peers chan peer.Peer
	// contains filtered or unexported fields
}

type ResponseProcessor interface {
	// Process handles an api.FindResponse, adding newly discovered peers to the unqueried
	// ClosestPeers heap.
	Process(*api.FindResponse, *Search) error
}

type Result struct {
	// Value found when looking for one, otherwise nil
	Value *api.Document

	// Closest is a heap of the responding peers found closest to the target
	Closest FarthestPeers

	// Unqueried is a heap of peers that were not yet queried
	Unqueried ClosestPeers

	// Queried is a set of all peers (keyed by peer.ID().String()) that have been queried (but
	// haven't yet necessarily responded or errored)
	Queried map[string]struct{}

	// Responded is a map of all peers that responded during search
	Responded map[string]peer.Peer

	// Errored contains the errors received by each peer (via string representation of peer ID)
	Errored map[string]error

	// FatalErr is a fatal error that occurred during the search
	FatalErr error
}

type Search struct {
	// ID search is looking for or close to
	Key id.ID

	// CreatRq creates new Find requests
	CreatRq func() *api.FindRequest

	// result of the search
	Result *Result

	// parameters defining the search
	Params *Parameters

	// mutex used to synchronizes reads and writes to this instance
	Mu sync.Mutex
}

type Searcher interface {
	// Search executes a search from a list of seeds.
	Search(search *Search, seeds []peer.Peer) error
}

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

type TestFromer struct {
	Peers map[string]peer.Peer
}