Changeset 50606a6

Timestamp:

Dec 9, 2011 8:19:00 PM (8 years ago)

Author:

zzz <zzz@…>

Branches:

master

Children:

1c4b033

Parents:

25b0603f

Message:

javadoc fix

File:

• router/java/src/net/i2p/data/i2np/UnknownI2NPMessage.java (modified) (3 diffs)

router/java/src/net/i2p/data/i2np/UnknownI2NPMessage.java

@@ -17 +17 @@
 
 /**
- * This is the same as DataMessage but with a variable message type.
+ * This is similar to DataMessage or GarlicMessage but with a variable message type.
  * This is defined so routers can route messages they don't know about.
- * We don't extend DataMessage so that any code that does (instanceof DataMessage)
+ * We don't extend those classes so that any code that does (instanceof foo)
  * won't return true for this type. Load tests use DataMessage, for example.
+ * Also, those classes include an additional length field that we can't use here.
  * See InboundMessageDistributor.
  *
  * There is no setData() method, the only way to create one of these is to
  * read it with readMessage() (i.e., it came from some other router)
+ *
+ * As of 0.8.12 this class is working. It is used at the IBGW to reduce the processing
+ * required. For zero-hop IB tunnels, the convert() method is used to reconstitute
+ * a standard message class.
  *
  * @since 0.7.12 but broken before 0.8.12
@@ -65 +70 @@
     }
     
-    /** @return 0-255 */
+    /**
+     *  Note that this returns the "true" type, so that
+     *  the IBGW can correctly make drop decisions.
+     *
+     *  @return 0-255
+     */
     public int getType() { return _type; }
     
@@ -86 +96 @@
      *
      *  @param offset starting at the ID (must skip the type)
-     *  @return total length of the message
      *  @since 0.8.12
      */