libp2p/go-libp2p-core
1
0
Fork 0
mirror of https://github.com/libp2p/go-libp2p-core.git synced 2024-12-26 23:30:27 +08:00
Code Issues Projects Releases Wiki Activity

doc(routing): document count

Browse Source 
Count == 0 now means that we search for an unbounded number of providers.
This commit is contained in:
Steven Allen 2020-04-09 10:59:58 -07:00
parent 2159f6a2ed
commit aa005892ff
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
routing/routing.go
View File

@ -30,6 +30,9 @@ type ContentRouting interface {
Provide(context.Context, cid.Cid, bool) error
// Search for peers who are able to provide a given key
//
// When count is 0, this method will return an unbounded number of
// results.
FindProvidersAsync(context.Context, cid.Cid, int) <-chan peer.AddrInfo
}
@ -37,7 +40,6 @@ type ContentRouting interface {
// This can be implemented by a simple lookup table, a tracking server,
// or even a DHT.
type PeerRouting interface {
// Find specific Peer
// FindPeer searches for a peer with given ID, returns a peer.AddrInfo
// with relevant addresses.
FindPeer(context.Context, peer.ID) (peer.AddrInfo, error)