From 42dfc502500fe2af67c0cf22eee3d7b02d0a93d4 Mon Sep 17 00:00:00 2001
From: Brian Tiger Chow <brian.holderchow@gmail.com>
Date: Mon, 27 Oct 2014 22:39:42 -0700
Subject: [PATCH] docs(bitswap/message) BitSwapMessage interface
---
exchange/bitswap/message/message.go | 19 +++++++++++++++++--
1 file changed, 17 insertions(+), 2 deletions(-)
diff --git a/exchange/bitswap/message/message.go b/exchange/bitswap/message/message.go
index 4b5735a9d..e0aea227d 100644
--- a/exchange/bitswap/message/message.go
+++ b/exchange/bitswap/message/message.go
@@ -14,10 +14,25 @@ import (
// TODO move bs/msg/internal/pb to bs/internal/pb and rename pb package to bitswap_pb
type BitSwapMessage interface {
+ // Wantlist returns a slice of unique keys that represent data wanted by
+ // the sender.
Wantlist() []u.Key
+
+ // Blocks returns a slice of unique blocks
Blocks() []blocks.Block
- AddWanted(k u.Key)
- AddBlock(b blocks.Block)
+
+ // AddWanted adds the key to the Wantlist.
+ //
+ // Insertion order determines priority. That is, earlier insertions are
+ // deemed higher priority than keys inserted later.
+ //
+ // t = 0, msg.AddWanted(A)
+ // t = 1, msg.AddWanted(B)
+ //
+ // implies Priority(A) > Priority(B)
+ AddWanted(u.Key)
+
+ AddBlock(blocks.Block)
Exportable
}
--
GitLab