forked from I2P_Developers/i2p.i2p
javadoc fixes part 10 (ticket #1894)
This commit is contained in:
@ -227,7 +227,7 @@ class ConnectionOptions extends I2PSocketOptionsImpl {
|
|||||||
* clearly from the math above that was not correct.
|
* clearly from the math above that was not correct.
|
||||||
* (Before 0.6.2, the reply leaseSet was bundled with every message, so it didn't even
|
* (Before 0.6.2, the reply leaseSet was bundled with every message, so it didn't even
|
||||||
* fit in TWO tunnel messages - more like 2 1/3)
|
* fit in TWO tunnel messages - more like 2 1/3)
|
||||||
* <p/>
|
* <p>
|
||||||
* Now, it's not clear how often we will get the ideal situation (no reply leaseSet bundling,
|
* Now, it's not clear how often we will get the ideal situation (no reply leaseSet bundling,
|
||||||
* no key bundling, and especially not having a small message ahead of you, which will then cause
|
* no key bundling, and especially not having a small message ahead of you, which will then cause
|
||||||
* fragmentation for all subsequent messages until the queue is emptied - BatchedPreprocessor
|
* fragmentation for all subsequent messages until the queue is emptied - BatchedPreprocessor
|
||||||
@ -235,7 +235,7 @@ class ConnectionOptions extends I2PSocketOptionsImpl {
|
|||||||
* messages in a new stream are much larger due to the leaseSet and key bundling.
|
* messages in a new stream are much larger due to the leaseSet and key bundling.
|
||||||
* But for long-lived streams (like with i2psnark) this should pay dividends.
|
* But for long-lived streams (like with i2psnark) this should pay dividends.
|
||||||
* The tunnel.batch* stats should provide some data for test comparisons.
|
* The tunnel.batch* stats should provide some data for test comparisons.
|
||||||
* <p/>
|
* <p>
|
||||||
* As MTU and MRU are identical and are negotiated to the lowest value
|
* As MTU and MRU are identical and are negotiated to the lowest value
|
||||||
* for the two ends, you can't do widespread testing of a higher value.
|
* for the two ends, you can't do widespread testing of a higher value.
|
||||||
* Unless we change to allow MTU and MRU to be different,
|
* Unless we change to allow MTU and MRU to be different,
|
||||||
@ -244,7 +244,7 @@ class ConnectionOptions extends I2PSocketOptionsImpl {
|
|||||||
* So let's try 1730 for release 0.6.5. This will allow for 738 testing as well,
|
* So let's try 1730 for release 0.6.5. This will allow for 738 testing as well,
|
||||||
* with i2p.streaming.maxMessageSize=738 (in configadvanced.jsp, or in i2ptunnel, or
|
* with i2p.streaming.maxMessageSize=738 (in configadvanced.jsp, or in i2ptunnel, or
|
||||||
* i2psnark, for example).
|
* i2psnark, for example).
|
||||||
* <p/>
|
* <p>
|
||||||
* Not that an isolated single packet is very common, but
|
* Not that an isolated single packet is very common, but
|
||||||
* in this case, 960 was 113.3% total overhead.
|
* in this case, 960 was 113.3% total overhead.
|
||||||
* Compared to 738 (38.8% overhead) and 1730 (18.4%).
|
* Compared to 738 (38.8% overhead) and 1730 (18.4%).
|
||||||
|
@ -6,18 +6,21 @@ import net.i2p.I2PAppContext;
|
|||||||
* <p>Scheduler used for after both sides have had their close packets
|
* <p>Scheduler used for after both sides have had their close packets
|
||||||
* ACKed, but the final timeout hasn't passed.</p>
|
* ACKed, but the final timeout hasn't passed.</p>
|
||||||
*
|
*
|
||||||
* <h2>Entry conditions:</h2><ul>
|
* <h2>Entry conditions:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>Both sides have closed and ACKed.</li>
|
* <li>Both sides have closed and ACKed.</li>
|
||||||
* <li>Less than the final timeout period has passed since the last ACK.</li>
|
* <li>Less than the final timeout period has passed since the last ACK.</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
* <h2>Events:</h2><ul>
|
* <h2>Events:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>Packets received</li>
|
* <li>Packets received</li>
|
||||||
* <li>RESET received</li>
|
* <li>RESET received</li>
|
||||||
* <li>Message sending fails (error talking to the session)</li>
|
* <li>Message sending fails (error talking to the session)</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
* <h2>Next states:</h2>
|
* <h2>Next states:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>{@link SchedulerDead dead} - after the final timeout passes</li>
|
* <li>{@link SchedulerDead dead} - after the final timeout passes</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
|
@ -8,12 +8,14 @@ import net.i2p.util.Log;
|
|||||||
* have closed the stream, but either we haven't ACKed their close or
|
* have closed the stream, but either we haven't ACKed their close or
|
||||||
* they haven't ACKed ours.</p>
|
* they haven't ACKed ours.</p>
|
||||||
*
|
*
|
||||||
* <h2>Entry conditions:</h2><ul>
|
* <h2>Entry conditions:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>Both sides have closed.</li>
|
* <li>Both sides have closed.</li>
|
||||||
* <li>At least one direction has not ACKed the close.</li>
|
* <li>At least one direction has not ACKed the close.</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
* <h2>Events:</h2><ul>
|
* <h2>Events:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>Packets received (which may or may not ACK the ones sent)</li>
|
* <li>Packets received (which may or may not ACK the ones sent)</li>
|
||||||
* <li>RESET received</li>
|
* <li>RESET received</li>
|
||||||
* <li>Message sending fails (error talking to the session)</li>
|
* <li>Message sending fails (error talking to the session)</li>
|
||||||
@ -21,6 +23,7 @@ import net.i2p.util.Log;
|
|||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
* <h2>Next states:</h2>
|
* <h2>Next states:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>{@link SchedulerClosed closed} - after both sending and receiving ACKs on the CLOSE</li>
|
* <li>{@link SchedulerClosed closed} - after both sending and receiving ACKs on the CLOSE</li>
|
||||||
* <li>{@link SchedulerDead dead} - after sending or receiving a RESET</li>
|
* <li>{@link SchedulerDead dead} - after sending or receiving a RESET</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
|
@ -8,12 +8,14 @@ import net.i2p.I2PAppContext;
|
|||||||
* stream must be using the BULK profile, rather than the INTERACTIVE
|
* stream must be using the BULK profile, rather than the INTERACTIVE
|
||||||
* profile.</p>
|
* profile.</p>
|
||||||
*
|
*
|
||||||
* <h2>Entry conditions:</h2><ul>
|
* <h2>Entry conditions:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>Packets sent and ACKs received.</li>
|
* <li>Packets sent and ACKs received.</li>
|
||||||
* <li>At least one direction is not closed</li>
|
* <li>At least one direction is not closed</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
* <h2>Events:</h2><ul>
|
* <h2>Events:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>Packets received (which may or may not ACK the ones sent)</li>
|
* <li>Packets received (which may or may not ACK the ones sent)</li>
|
||||||
* <li>Message flush (explicitly, through a full buffer, or stream closure)</li>
|
* <li>Message flush (explicitly, through a full buffer, or stream closure)</li>
|
||||||
* <li>RESET received</li>
|
* <li>RESET received</li>
|
||||||
@ -22,6 +24,7 @@ import net.i2p.I2PAppContext;
|
|||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
* <h2>Next states:</h2>
|
* <h2>Next states:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>{@link SchedulerClosing closing} - after both sending and receiving a CLOSE</li>
|
* <li>{@link SchedulerClosing closing} - after both sending and receiving a CLOSE</li>
|
||||||
* <li>{@link SchedulerClosed closed} - after both sending and receiving ACKs on the CLOSE</li>
|
* <li>{@link SchedulerClosed closed} - after both sending and receiving ACKs on the CLOSE</li>
|
||||||
* <li>{@link SchedulerDead dead} - after sending or receiving a RESET</li>
|
* <li>{@link SchedulerDead dead} - after sending or receiving a RESET</li>
|
||||||
|
@ -7,11 +7,13 @@ import net.i2p.util.Log;
|
|||||||
* <p>Scheduler used once we've sent our SYN but it hasn't been ACKed yet.
|
* <p>Scheduler used once we've sent our SYN but it hasn't been ACKed yet.
|
||||||
* This connection may or may not be locally created.</p>
|
* This connection may or may not be locally created.</p>
|
||||||
*
|
*
|
||||||
* <h2>Entry conditions:</h2><ul>
|
* <h2>Entry conditions:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>Packets sent but none ACKed</li>
|
* <li>Packets sent but none ACKed</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
* <h2>Events:</h2><ul>
|
* <h2>Events:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>Packets received (which may or may not ACK the ones sent)</li>
|
* <li>Packets received (which may or may not ACK the ones sent)</li>
|
||||||
* <li>Message flush (explicitly, through a full buffer, or stream closure)</li>
|
* <li>Message flush (explicitly, through a full buffer, or stream closure)</li>
|
||||||
* <li>Connection establishment timeout</li>
|
* <li>Connection establishment timeout</li>
|
||||||
@ -19,6 +21,7 @@ import net.i2p.util.Log;
|
|||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
* <h2>Next states:</h2>
|
* <h2>Next states:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>{@link SchedulerConnectedBulk connected} - after receiving an ACK</li>
|
* <li>{@link SchedulerConnectedBulk connected} - after receiving an ACK</li>
|
||||||
* <li>{@link SchedulerClosing closing} - after both sending and receiving a CLOSE</li>
|
* <li>{@link SchedulerClosing closing} - after both sending and receiving a CLOSE</li>
|
||||||
* <li>{@link SchedulerClosed closed} - after both sending and receiving ACKs on the CLOSE</li>
|
* <li>{@link SchedulerClosed closed} - after both sending and receiving ACKs on the CLOSE</li>
|
||||||
|
@ -6,17 +6,20 @@ import net.i2p.I2PAppContext;
|
|||||||
* <p>Scheduler used for after the final timeout has passed or the
|
* <p>Scheduler used for after the final timeout has passed or the
|
||||||
* connection was reset.</p>
|
* connection was reset.</p>
|
||||||
*
|
*
|
||||||
* <h2>Entry conditions:</h2><ul>
|
* <h2>Entry conditions:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>Both sides have closed and ACKed and the timeout has passed. <br>
|
* <li>Both sides have closed and ACKed and the timeout has passed. <br>
|
||||||
* <b>or</b></li>
|
* <b>or</b></li>
|
||||||
* <li>A RESET was received</li>
|
* <li>A RESET was received</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
* <h2>Events:</h2><ul>
|
* <h2>Events:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>None</li>
|
* <li>None</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
* <h2>Next states:</h2>
|
* <h2>Next states:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>None</li>
|
* <li>None</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
|
@ -6,18 +6,21 @@ import net.i2p.I2PAppContext;
|
|||||||
* <p>Scheduler used after we've locally done a hard disconnect,
|
* <p>Scheduler used after we've locally done a hard disconnect,
|
||||||
* but the final timeout hasn't passed.</p>
|
* but the final timeout hasn't passed.</p>
|
||||||
*
|
*
|
||||||
* <h2>Entry conditions:</h2><ul>
|
* <h2>Entry conditions:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>Locally disconnected hard.</li>
|
* <li>Locally disconnected hard.</li>
|
||||||
* <li>Less than the final timeout period has passed since the last ACK.</li>
|
* <li>Less than the final timeout period has passed since the last ACK.</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
* <h2>Events:</h2><ul>
|
* <h2>Events:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>Packets received</li>
|
* <li>Packets received</li>
|
||||||
* <li>RESET received</li>
|
* <li>RESET received</li>
|
||||||
* <li>Message sending fails (error talking to the session)</li>
|
* <li>Message sending fails (error talking to the session)</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
* <h2>Next states:</h2>
|
* <h2>Next states:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>{@link SchedulerDead dead} - after the final timeout passes</li>
|
* <li>{@link SchedulerDead dead} - after the final timeout passes</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
|
@ -7,12 +7,14 @@ import net.i2p.util.Log;
|
|||||||
* <p>Scheduler used for locally created connections where we have not yet
|
* <p>Scheduler used for locally created connections where we have not yet
|
||||||
* sent the initial SYN packet.</p>
|
* sent the initial SYN packet.</p>
|
||||||
*
|
*
|
||||||
* <h2>Entry conditions:</h2><ul>
|
* <h2>Entry conditions:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>Locally created</li>
|
* <li>Locally created</li>
|
||||||
* <li>No packets sent or received</li>
|
* <li>No packets sent or received</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
* <h2>Events:</h2><ul>
|
* <h2>Events:</h2>
|
||||||
|
* <ul>
|
||||||
* <li>Message flush (explicitly, through a full buffer, or stream closure)</li>
|
* <li>Message flush (explicitly, through a full buffer, or stream closure)</li>
|
||||||
* <li>Initial delay timeout (causing implicit flush of any data available)</li>
|
* <li>Initial delay timeout (causing implicit flush of any data available)</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
|
@ -18,7 +18,7 @@ import net.i2p.router.Router;
|
|||||||
* (and all that entails). In addition, this creates a root I2PAppContext for
|
* (and all that entails). In addition, this creates a root I2PAppContext for
|
||||||
* any objects not booted through one of the RouterContexts. Each of these
|
* any objects not booted through one of the RouterContexts. Each of these
|
||||||
* contexts are configured through a simple properties file (where the name=value
|
* contexts are configured through a simple properties file (where the name=value
|
||||||
* contained in them are used for the context's getProperty(name)). <p />
|
* contained in them are used for the context's getProperty(name)). <p>
|
||||||
*
|
*
|
||||||
* <b>Usage:</b><pre>
|
* <b>Usage:</b><pre>
|
||||||
* MultiRouter numberRouters
|
* MultiRouter numberRouters
|
||||||
@ -40,7 +40,7 @@ import net.i2p.router.Router;
|
|||||||
* the CPU load (but obviously making the router incapable of talking to things
|
* the CPU load (but obviously making the router incapable of talking to things
|
||||||
* that need the encryption enabled). To run a client app through a router that
|
* that need the encryption enabled). To run a client app through a router that
|
||||||
* has i2p.encryption=off, you should also add that line to the client's JVM
|
* has i2p.encryption=off, you should also add that line to the client's JVM
|
||||||
* (for example, <code>java -Di2p.encryption=off -jar lib/i2ptunnel.jar</code>).<p />
|
* (for example, <code>java -Di2p.encryption=off -jar lib/i2ptunnel.jar</code>).<p>
|
||||||
*
|
*
|
||||||
* To make the router console work, either run from a directory containing
|
* To make the router console work, either run from a directory containing
|
||||||
* lib/, webapps/, docs/, etc., or point i2p.dir.base to a directory containing the
|
* lib/, webapps/, docs/, etc., or point i2p.dir.base to a directory containing the
|
||||||
|
@ -223,8 +223,8 @@ public class Action
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @deprecated You should use one of the following methods instead:<br />
|
* @deprecated You should use one of the following methods instead:<br>
|
||||||
* - {@link #setInArgumentValues(ArgumentList)} <br/>
|
* - {@link #setInArgumentValues(ArgumentList)} <br>
|
||||||
* - {@link #setOutArgumentValues(ArgumentList)}
|
* - {@link #setOutArgumentValues(ArgumentList)}
|
||||||
*/
|
*/
|
||||||
@Deprecated
|
@Deprecated
|
||||||
|
Reference in New Issue
Block a user