Clarify asynchronous nature of Decode()

harmony-one · Dec 18, 2018 · 9c7b8bd · 9c7b8bd
1 parent ba01b57
commit 9c7b8bd
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/pkg/raptorq/interface.go b/pkg/raptorq/interface.go
@@ -116,6 +116,11 @@ type Decoder interface {
  ObjectInfo
 
  // Decode decodes a received encoding symbol.
+ //
+ // The result of decoding may not be available immediately after Decode
+ // returns; IsSourceBlockReady or IsSourceObjectReady may not
+ // immediately return true even if the symbol made the source block or
+ // the source object available.
  Decode(sbn uint8, esi uint32, symbol []byte)
 
  // IsSourceBlockReady returns whether the given source block has been fully