javadoc fixes
This commit is contained in:
@ -318,7 +318,7 @@ public class Connection {
|
|||||||
public byte[] getSendStreamId() { return _sendStreamId; }
|
public byte[] getSendStreamId() { return _sendStreamId; }
|
||||||
public void setSendStreamId(byte[] id) { _sendStreamId = id; }
|
public void setSendStreamId(byte[] id) { _sendStreamId = id; }
|
||||||
|
|
||||||
/** what stream does the peer send data to us on? (may be null) */
|
/** stream the peer sends data to us on. (may be null) */
|
||||||
public byte[] getReceiveStreamId() { return _receiveStreamId; }
|
public byte[] getReceiveStreamId() { return _receiveStreamId; }
|
||||||
public void setReceiveStreamId(byte[] id) { _receiveStreamId = id; }
|
public void setReceiveStreamId(byte[] id) { _receiveStreamId = id; }
|
||||||
|
|
||||||
@ -343,9 +343,9 @@ public class Connection {
|
|||||||
public ConnectionPacketHandler getPacketHandler() { return _handler; }
|
public ConnectionPacketHandler getPacketHandler() { return _handler; }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* when does the scheduler next want to send a packet? -1 if never.
|
* Time when the scheduler next want to send a packet, or -1 if
|
||||||
* This should be set when we want to send on timeout, for instance, or
|
* never. This should be set when we want to send on timeout, for
|
||||||
* want to delay an ACK.
|
* instance, or want to delay an ACK.
|
||||||
*/
|
*/
|
||||||
public long getNextSendTime() { return _nextSendTime; }
|
public long getNextSendTime() { return _nextSendTime; }
|
||||||
public void setNextSendTime(long when) {
|
public void setNextSendTime(long when) {
|
||||||
|
@ -191,7 +191,7 @@ public class MessageOutputStream extends OutputStream {
|
|||||||
* which we throttle rather than accept arbitrary data and queue
|
* which we throttle rather than accept arbitrary data and queue
|
||||||
*/
|
*/
|
||||||
public void waitForAccept(int maxWaitMs);
|
public void waitForAccept(int maxWaitMs);
|
||||||
/** was the write accepted? aka did the socket not close? */
|
/** the write was accepted. aka did the socket not close? */
|
||||||
public boolean writeAccepted();
|
public boolean writeAccepted();
|
||||||
/** did the write fail? */
|
/** did the write fail? */
|
||||||
public boolean writeFailed();
|
public boolean writeFailed();
|
||||||
|
@ -11,13 +11,13 @@ import net.i2p.data.SigningPrivateKey;
|
|||||||
/**
|
/**
|
||||||
* Contain a single packet transferred as part of a streaming connection.
|
* Contain a single packet transferred as part of a streaming connection.
|
||||||
* The data format is as follows:<ul>
|
* The data format is as follows:<ul>
|
||||||
* <li>{@see #getSendStreamId sendStreamId} [4 byte value]</li>
|
* <li>{@link #getSendStreamId sendStreamId} [4 byte value]</li>
|
||||||
* <li>{@see #getReceiveStreamId receiveStreamId} [4 byte value]</li>
|
* <li>{@link #getReceiveStreamId receiveStreamId} [4 byte value]</li>
|
||||||
* <li>{@see #getSequenceNum sequenceNum} [4 byte unsigned integer]</li>
|
* <li>{@link #getSequenceNum sequenceNum} [4 byte unsigned integer]</li>
|
||||||
* <li>{@see #getAckThrough ackThrough} [4 byte unsigned integer]</li>
|
* <li>{@link #getAckThrough ackThrough} [4 byte unsigned integer]</li>
|
||||||
* <li>number of NACKs [1 byte unsigned integer]</li>
|
* <li>number of NACKs [1 byte unsigned integer]</li>
|
||||||
* <li>that many {@see #getNacks NACKs}</li>
|
* <li>that many {@link #getNacks NACKs}</li>
|
||||||
* <li>{@see #getResendDelay resendDelay} [1 byte integer]</li>
|
* <li>{@link #getResendDelay resendDelay} [1 byte integer]</li>
|
||||||
* <li>flags [2 byte value]</li>
|
* <li>flags [2 byte value]</li>
|
||||||
* <li>option data size [2 byte integer]</li>
|
* <li>option data size [2 byte integer]</li>
|
||||||
* <li>option data specified by those flags [0 or more bytes]</li>
|
* <li>option data specified by those flags [0 or more bytes]</li>
|
||||||
@ -28,15 +28,15 @@ import net.i2p.data.SigningPrivateKey;
|
|||||||
* turn may require certain additional data to be included. The flags are
|
* turn may require certain additional data to be included. The flags are
|
||||||
* as follows (with any data structures specified added to the options area
|
* as follows (with any data structures specified added to the options area
|
||||||
* in the given order):</p><ol>
|
* in the given order):</p><ol>
|
||||||
* <li>{@see #FLAG_SYNCHRONIZE}: no option data</li>
|
* <li>{@link #FLAG_SYNCHRONIZE}: no option data</li>
|
||||||
* <li>{@see #FLAG_CLOSE}: no option data</li>
|
* <li>{@link #FLAG_CLOSE}: no option data</li>
|
||||||
* <li>{@see #FLAG_RESET}: no option data</li>
|
* <li>{@link #FLAG_RESET}: no option data</li>
|
||||||
* <li>{@see #FLAG_SIGNATURE_INCLUDED}: {@see net.i2p.data.Signature}</li>
|
* <li>{@link #FLAG_SIGNATURE_INCLUDED}: {@link net.i2p.data.Signature}</li>
|
||||||
* <li>{@see #FLAG_SIGNATURE_REQUESTED}: no option data</li>
|
* <li>{@link #FLAG_SIGNATURE_REQUESTED}: no option data</li>
|
||||||
* <li>{@see #FLAG_FROM_INCLUDED}: {@see net.i2p.data.Destination}</li>
|
* <li>{@link #FLAG_FROM_INCLUDED}: {@link net.i2p.data.Destination}</li>
|
||||||
* <li>{@see #FLAG_DELAY_REQUESTED}: 1 byte integer</li>
|
* <li>{@link #FLAG_DELAY_REQUESTED}: 1 byte integer</li>
|
||||||
* <li>{@see #FLAG_MAX_PACKET_SIZE_INCLUDED}: 2 byte integer</li>
|
* <li>{@link #FLAG_MAX_PACKET_SIZE_INCLUDED}: 2 byte integer</li>
|
||||||
* <li>{@see #FLAG_PROFILE_INTERACTIVE}: no option data</li>
|
* <li>{@link #FLAG_PROFILE_INTERACTIVE}: no option data</li>
|
||||||
* </ol>
|
* </ol>
|
||||||
*
|
*
|
||||||
* <p>If the signature is included, it uses the Destination's DSA key
|
* <p>If the signature is included, it uses the Destination's DSA key
|
||||||
@ -149,7 +149,7 @@ public class Packet {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* what is the stream replies should be sent on? if the
|
* Stream that replies should be sent on. if the
|
||||||
* connection is still being built, this should be
|
* connection is still being built, this should be
|
||||||
* null.
|
* null.
|
||||||
*
|
*
|
||||||
@ -171,8 +171,8 @@ public class Packet {
|
|||||||
public void setSequenceNum(long num) { _sequenceNum = num; }
|
public void setSequenceNum(long num) { _sequenceNum = num; }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* what is the highest packet sequence number that received
|
* The highest packet sequence number that received
|
||||||
* on the receiveStreamId? This field is ignored on the initial
|
* on the receiveStreamId. This field is ignored on the initial
|
||||||
* connection packet (where receiveStreamId is the unknown id).
|
* connection packet (where receiveStreamId is the unknown id).
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@ -180,8 +180,8 @@ public class Packet {
|
|||||||
public void setAckThrough(long id) { _ackThrough = id; }
|
public void setAckThrough(long id) { _ackThrough = id; }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* What packet sequence numbers below the getAckThrough() value
|
* List of packet sequence numbers below the getAckThrough() value
|
||||||
* have not been received? this may be null.
|
* have not been received. this may be null.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
public long[] getNacks() { return _nacks; }
|
public long[] getNacks() { return _nacks; }
|
||||||
|
@ -19,7 +19,7 @@ import net.i2p.util.Log;
|
|||||||
* </ul>
|
* </ul>
|
||||||
*
|
*
|
||||||
* <h2>Next states:</h2>
|
* <h2>Next states:</h2>
|
||||||
* <li>{@link SchedulerConnected 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>
|
||||||
* <li>{@link SchedulerDead dead} - after sending or receiving a RESET</li>
|
* <li>{@link SchedulerDead dead} - after sending or receiving a RESET</li>
|
||||||
|
Reference in New Issue
Block a user