providers: add some documentation

3c9d0447 · Steven Allen · 24c38411 · 3c9d0447
Commit 3c9d0447 authored Apr 12, 2019 by Steven Allen
Hide whitespace changes
Inline Side-by-side

Showing with 3 additions and 0 deletions

providers/providers.go providers/providers.go +3 -0

No files found.
--- a/providers/providers.go
+++ b/providers/providers.go
@@ -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,