providers: add some documentation

This commit is contained in:
Steven Allen 2019-04-12 21:45:17 -07:00
parent 24c3841189
commit 3c9d044798

View File

@ -312,6 +312,7 @@ func (pm *ProviderManager) run() {
}
}
// AddProvider adds a provider.
func (pm *ProviderManager) AddProvider(ctx context.Context, k cid.Cid, val peer.ID) {
prov := &addProv{
k: k,
@ -323,6 +324,8 @@ func (pm *ProviderManager) AddProvider(ctx context.Context, k cid.Cid, val peer.
}
}
// GetProviders returns the set of providers for the given key.
// This method _does not_ copy the set. Do not modify it.
func (pm *ProviderManager) GetProviders(ctx context.Context, k cid.Cid) []peer.ID {
gp := &getProv{
k: k,