From e2abff3bea79bb94d5baaed34dd8918b094c5672 Mon Sep 17 00:00:00 2001 From: Andrew Gerrand Date: Wed, 24 Jul 2013 11:09:53 +1000 Subject: [PATCH] add docs to PeerPicker --- peers.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/peers.go b/peers.go index 4644640..dfaf5df 100644 --- a/peers.go +++ b/peers.go @@ -35,6 +35,9 @@ type ProtoGetter interface { // PeerPicker is the interface that must be implemented to locate // the peer that owns a specific key. type PeerPicker interface { + // PickPeer returns the peer that owns the specific key + // and true to indicate that a remote peer was nominated. + // It returns nil, false if the key owner is the current peer. PickPeer(key string) (peer ProtoGetter, ok bool) }