From 0c661b373e7c079b3c7b31133bdf1f91f3c13530 Mon Sep 17 00:00:00 2001 From: zzz Date: Sun, 28 Aug 2011 17:29:42 +0000 Subject: [PATCH] javadocs --- .../i2p/data/i2np/DatabaseLookupMessage.java | 2 ++ .../src/net/i2p/router/MessageSelector.java | 20 ++++++++++++++----- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/router/java/src/net/i2p/data/i2np/DatabaseLookupMessage.java b/router/java/src/net/i2p/data/i2np/DatabaseLookupMessage.java index 18bc54b49..bad38627b 100644 --- a/router/java/src/net/i2p/data/i2np/DatabaseLookupMessage.java +++ b/router/java/src/net/i2p/data/i2np/DatabaseLookupMessage.java @@ -46,6 +46,8 @@ public class DatabaseLookupMessage extends I2NPMessageImpl { public DatabaseLookupMessage(I2PAppContext context) { this(context, false); } + + /** @param locallyCreated ignored */ public DatabaseLookupMessage(I2PAppContext context, boolean locallyCreated) { super(context); //setSearchKey(null); diff --git a/router/java/src/net/i2p/router/MessageSelector.java b/router/java/src/net/i2p/router/MessageSelector.java index ef35485c6..49db05e6e 100644 --- a/router/java/src/net/i2p/router/MessageSelector.java +++ b/router/java/src/net/i2p/router/MessageSelector.java @@ -16,19 +16,29 @@ import net.i2p.data.i2np.I2NPMessage; * */ public interface MessageSelector { + /** - * Returns true if the received message matches the selector + * Returns true if the received message matches the selector. + * If this returns true, the job specified by OutNetMessage.getOnReplyJob() + * will be run for every OutNetMessage associated with this selector + * (by InNetMessagePool), after calling setMessage() for that ReplyJob. */ public boolean isMatch(I2NPMessage message); + /** - * Returns true if the selector should still keep searching for further matches - * + * Returns true if the selector should still keep searching for further matches. + * This is called only if isMatch() returns true. + * If this returns true, isMatch() will not be called again. */ public boolean continueMatching(); + /** * Returns the # of milliseconds since the epoch after which this selector should - * stop searching for matches - * + * stop searching for matches. + * At some time after expiration, if continueMatching() has not returned false, + * the job specified by OutNetMessage.getOnFailedReplyJob() + * will be run for every OutNetMessage associated with this selector + * (by OutboundMessageRegistry). */ public long getExpiration(); }