javadoc fixes part 10 (ticket #1894)

This commit is contained in:
zzz
2017-01-27 01:49:19 +00:00
parent fb74f41692
commit bd1354f95b
10 changed files with 41 additions and 21 deletions

View File

@ -227,7 +227,7 @@ class ConnectionOptions extends I2PSocketOptionsImpl {
* 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
* 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,
* 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
@ -235,7 +235,7 @@ class ConnectionOptions extends I2PSocketOptionsImpl {
* 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.
* 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
* 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,
@ -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,
* with i2p.streaming.maxMessageSize=738 (in configadvanced.jsp, or in i2ptunnel, or
* i2psnark, for example).
* <p/>
* <p>
* Not that an isolated single packet is very common, but
* in this case, 960 was 113.3% total overhead.
* Compared to 738 (38.8% overhead) and 1730 (18.4%).

View File

@ -6,18 +6,21 @@ import net.i2p.I2PAppContext;
* <p>Scheduler used for after both sides have had their close packets
* 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>Less than the final timeout period has passed since the last ACK.</li>
* </ul>
*
* <h2>Events:</h2><ul>
* <h2>Events:</h2>
* <ul>
* <li>Packets received</li>
* <li>RESET received</li>
* <li>Message sending fails (error talking to the session)</li>
* </ul>
*
* <h2>Next states:</h2>
* <ul>
* <li>{@link SchedulerDead dead} - after the final timeout passes</li>
* </ul>
*

View File

@ -8,12 +8,14 @@ import net.i2p.util.Log;
* have closed the stream, but either we haven't ACKed their close or
* they haven't ACKed ours.</p>
*
* <h2>Entry conditions:</h2><ul>
* <h2>Entry conditions:</h2>
* <ul>
* <li>Both sides have closed.</li>
* <li>At least one direction has not ACKed the close.</li>
* </ul>
*
* <h2>Events:</h2><ul>
* <h2>Events:</h2>
* <ul>
* <li>Packets received (which may or may not ACK the ones sent)</li>
* <li>RESET received</li>
* <li>Message sending fails (error talking to the session)</li>
@ -21,6 +23,7 @@ import net.i2p.util.Log;
* </ul>
*
* <h2>Next states:</h2>
* <ul>
* <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>
* </ul>

View File

@ -8,12 +8,14 @@ import net.i2p.I2PAppContext;
* stream must be using the BULK profile, rather than the INTERACTIVE
* profile.</p>
*
* <h2>Entry conditions:</h2><ul>
* <h2>Entry conditions:</h2>
* <ul>
* <li>Packets sent and ACKs received.</li>
* <li>At least one direction is not closed</li>
* </ul>
*
* <h2>Events:</h2><ul>
* <h2>Events:</h2>
* <ul>
* <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>RESET received</li>
@ -22,6 +24,7 @@ import net.i2p.I2PAppContext;
* </ul>
*
* <h2>Next states:</h2>
* <ul>
* <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 SchedulerDead dead} - after sending or receiving a RESET</li>

View File

@ -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.
* 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>
* </ul>
*
* <h2>Events:</h2><ul>
* <h2>Events:</h2>
* <ul>
* <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>Connection establishment timeout</li>
@ -19,6 +21,7 @@ import net.i2p.util.Log;
* </ul>
*
* <h2>Next states:</h2>
* <ul>
* <li>{@link SchedulerConnectedBulk connected} - after receiving an ACK</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>

View File

@ -6,17 +6,20 @@ import net.i2p.I2PAppContext;
* <p>Scheduler used for after the final timeout has passed or the
* 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>
* <b>or</b></li>
* <li>A RESET was received</li>
* </ul>
*
* <h2>Events:</h2><ul>
* <h2>Events:</h2>
* <ul>
* <li>None</li>
* </ul>
*
* <h2>Next states:</h2>
* <ul>
* <li>None</li>
* </ul>
*

View File

@ -6,18 +6,21 @@ import net.i2p.I2PAppContext;
* <p>Scheduler used after we've locally done a hard disconnect,
* but the final timeout hasn't passed.</p>
*
* <h2>Entry conditions:</h2><ul>
* <h2>Entry conditions:</h2>
* <ul>
* <li>Locally disconnected hard.</li>
* <li>Less than the final timeout period has passed since the last ACK.</li>
* </ul>
*
* <h2>Events:</h2><ul>
* <h2>Events:</h2>
* <ul>
* <li>Packets received</li>
* <li>RESET received</li>
* <li>Message sending fails (error talking to the session)</li>
* </ul>
*
* <h2>Next states:</h2>
* <ul>
* <li>{@link SchedulerDead dead} - after the final timeout passes</li>
* </ul>
*

View File

@ -7,12 +7,14 @@ import net.i2p.util.Log;
* <p>Scheduler used for locally created connections where we have not yet
* sent the initial SYN packet.</p>
*
* <h2>Entry conditions:</h2><ul>
* <h2>Entry conditions:</h2>
* <ul>
* <li>Locally created</li>
* <li>No packets sent or received</li>
* </ul>
*
* <h2>Events:</h2><ul>
* <h2>Events:</h2>
* <ul>
* <li>Message flush (explicitly, through a full buffer, or stream closure)</li>
* <li>Initial delay timeout (causing implicit flush of any data available)</li>
* </ul>