mirror of
https://github.com/libp2p/go-libp2p-core.git
synced 2025-01-29 04:40:10 +08:00
Merge pull request #140 from libp2p/docs/routing
doc(routing): document count
This commit is contained in:
commit
eb00c1a72e
@ -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)
|
||||
|
Loading…
Reference in New Issue
Block a user