add comment to the new getUniqueID code

i2p · Jun 4, 2023 · f0df5d1 · f0df5d1
1 parent 9c5118f
commit f0df5d1
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/router/java/src/net/i2p/data/i2np/I2NPMessage.java b/router/java/src/net/i2p/data/i2np/I2NPMessage.java
@@ -86,6 +86,10 @@ public interface I2NPMessage {
 
     /**
      * Replay resistant message ID
+     * optionally, the caller may pass a msgIDBloomXor value, and the
+     * return value will be Xor'ed with that value. Passing a msgIDBloomXor
+     * value of 0 will result in the original ID being returned, instead of
+     * passing 0 use the no-arg version.
      */
     public long getUniqueId(long msgIDBloomXor); 
     public long getUniqueId();