Changeset eefb36c


Ignore:
Timestamp:
Jan 26, 2017 9:37:23 PM (4 years ago)
Author:
zzz <zzz@…>
Branches:
master
Children:
d196047
Parents:
dc5bfb2
Message:

javadoc fixes part 5 (ticket #1894)

Files:
19 edited

Legend:

Unmodified
Added
Removed
  • core/java/src/net/i2p/crypto/SHA1.java

    rdc5bfb2 reefb36c  
    6363 *   <li> Bruce Schneier, "Section 18.7 Secure Hash Algorithm (SHA)",
    6464 *      <cite>Applied Cryptography, 2nd edition</cite>, <br>
    65  *      John Wiley & Sons, 1996</li>
     65 *      John Wiley &amp; Sons, 1996</li>
    6666 * </ol>
    6767 */
  • core/java/src/net/i2p/kademlia/KBucketImpl.java

    rdc5bfb2 reefb36c  
    3535 *  Per-key last-seen-time, failures, etc. must be tracked elsewhere.
    3636 *
    37  *  If this bucket is full (i.e. begin == end && size == max)
     37 *  If this bucket is full (i.e. begin == end &amp;&amp; size == max)
    3838 *  then add() will call KBucketTrimmer.trim() do
    3939 *  (possibly) remove older entries, and indicate whether
  • core/java/src/net/metanotion/io/block/BlockFile.java

    rdc5bfb2 reefb36c  
    338338         *  Go to any page but the superblock.
    339339         *  Page 1 is the superblock, must use file.seek(0) to get there.
    340          *  @param page >= 2
     340         *  @param page &gt;= 2
    341341         */
    342342        public static void pageSeek(RandomAccessInterface file, int page) throws IOException {
  • core/java/src/net/metanotion/io/block/index/BSkipList.java

    rdc5bfb2 reefb36c  
    222222****/
    223223
     224        /** find */
    224225        @Override
    225226        public SkipIterator<K, V> find(K key) {
  • router/java/src/net/i2p/data/i2np/I2NPMessage.java

    rdc5bfb2 reefb36c  
    3939     *
    4040     * @param in stream to read from
    41      *           starting at type if type is < 0 (16 byte header)
    42      *           starting at ID if type is >= 0 (15 byte header)
     41     *           starting at type if type is &lt; 0 (16 byte header)
     42     *           starting at ID if type is &gt;= 0 (15 byte header)
    4343     * @param type I2NP message type. If less than zero, read the type from data
    4444     * @param buffer scratch buffer to be used when reading and parsing
     
    5959     * @param type I2NP message type. If less than zero, read the type from data
    6060     * @param offset where to start
    61      *           starting at type if type is < 0 (16 byte header)
    62      *           starting at ID if type is >= 0 (15 byte header)
     61     *           starting at type if type is &lt; 0 (16 byte header)
     62     *           starting at ID if type is &gt;= 0 (15 byte header)
    6363     * @return size of the message read (including headers)
    6464     * @throws I2NPMessageException if there is no valid message
     
    7474     * @param type I2NP message type. If less than zero, read the type from data
    7575     * @param offset where to start
    76      *           starting at type if type is < 0 (16 byte header)
    77      *           starting at ID if type is >= 0 (15 byte header)
     76     *           starting at type if type is &lt; 0 (16 byte header)
     77     *           starting at ID if type is &gt;= 0 (15 byte header)
    7878     * @param maxLen read no more than this many bytes from data starting at offset, even if it is longer
    79      *               This includes the type byte only if type < 0
     79     *               This includes the type byte only if type &lt; 0
    8080     * @return size of the message read (including headers)
    8181     * @throws I2NPMessageException if there is no valid message
  • router/java/src/net/i2p/router/TunnelPoolSettings.java

    rdc5bfb2 reefb36c  
    167167     * Always true for exploratory.
    168168     * Generally true for client, but should probably be ignored...
    169      * use getLength() + getLengthVariance() > 0 instead.
     169     * use getLength() + getLengthVariance() &gt; 0 instead.
    170170     */
    171171    public boolean getAllowZeroHop() { return _allowZeroHop; }
  • router/java/src/net/i2p/router/client/LookupDestJob.java

    rdc5bfb2 reefb36c  
    4444     *  even if the dest uses unsupported crypto.
    4545     *
    46      *  @param reqID must be >= 0 if name != null
    47      *  @param sessID must non-null if reqID >= 0
     46     *  @param reqID must be &gt;= 0 if name != null
     47     *  @param sessID must non-null if reqID &gt;= 0
    4848     *  @param fromLocalDest use these tunnels for the lookup, or null for exploratory
    4949     *  @since 0.9.11
  • router/java/src/net/i2p/router/message/GarlicMessageBuilder.java

    rdc5bfb2 reefb36c  
    3636    /**
    3737     *  @param local non-null; do not use this method for the router's SessionKeyManager
    38      *  @param minTagOverride 0 for no override, > 0 to override SKM's settings
     38     *  @param minTagOverride 0 for no override, &gt; 0 to override SKM's settings
    3939     */
    4040    static boolean needsTags(RouterContext ctx, PublicKey key, Hash local, int minTagOverride) {
  • router/java/src/net/i2p/router/message/OutboundClientMessageJobHelper.java

    rdc5bfb2 reefb36c  
    100100     * This is called from OCMOSJ
    101101     *
    102      * @param tagsToSendOverride if > 0, use this instead of skm's default
    103      * @param lowTagsOverride if > 0, use this instead of skm's default
     102     * @param tagsToSendOverride if &gt; 0, use this instead of skm's default
     103     * @param lowTagsOverride if &gt; 0, use this instead of skm's default
    104104     * @param wrappedKey output parameter that will be filled with the sessionKey used
    105105     * @param wrappedTags output parameter that will be filled with the sessionTags used
  • router/java/src/net/i2p/router/networkdb/kademlia/FloodfillPeerSelector.java

    rdc5bfb2 reefb36c  
    152152     *  @param kbuckets now unused
    153153     *
    154      *  Sorted by closest to the key if > maxNumRouters, otherwise not
     154     *  Sorted by closest to the key if &gt; maxNumRouters, otherwise not
    155155     *  The list is in 3 groups - sorted by routing key within each group.
    156156     *  Group 1: No store or lookup failure in a long time, and
  • router/java/src/net/i2p/router/time/NtpMessage.java

    rdc5bfb2 reefb36c  
    279279   
    280280    /**
    281      * Constructs a new NtpMessage in client -> server mode, and sets the
     281     * Constructs a new NtpMessage in client -&gt; server mode, and sets the
    282282     * transmit timestamp to the current time.
    283283     */
  • router/java/src/net/i2p/router/transport/FIFOBandwidthLimiter.java

    rdc5bfb2 reefb36c  
    834834         *  Only used by SSU.
    835835         *  May return without allocating.
    836          *  Check getPendingRequested() > 0 in a loop.
     836         *  Check getPendingRequested() &gt; 0 in a loop.
    837837         */
    838838        public void waitForNextAllocation() {
     
    913913         *  Block until we are allocated some more bytes.
    914914         *  May return without allocating.
    915          *  Check getPendingRequested() > 0 in a loop.
     915         *  Check getPendingRequested() &gt; 0 in a loop.
    916916         */
    917917        public void waitForNextAllocation();
  • router/java/src/net/i2p/router/transport/FIFOBandwidthRefiller.java

    rdc5bfb2 reefb36c  
    5252    public static final int DEFAULT_INBOUND_BANDWIDTH = 300;
    5353    /**
    54      *  Caution, do not make DEFAULT_OUTBOUND_BANDWIDTH * DEFAULT_SHARE_PCT > 32
     54     *  Caution, do not make DEFAULT_OUTBOUND_BANDWIDTH * DEFAULT_SHARE_PCT &gt; 32
    5555     *  without thinking about the implications (default connection limits, for example)
    5656     *  of moving the default bandwidth class from L to M, or maybe
  • router/java/src/net/i2p/router/transport/ntcp/EstablishState.java

    rdc5bfb2 reefb36c  
    3131 *
    3232 * Message 1 (Session Request):
    33  *  X+(H(X) xor Bob.identHash)----------------------------->
     33 *  X+(H(X) xor Bob.identHash)-----------------------------&gt;
    3434 *
    3535 * Message 2 (Session Created):
    36  *  <----------------------------------------Y+E(H(X+Y)+tsB, sk, Y[239:255])
     36 *  &lt;----------------------------------------Y+E(H(X+Y)+tsB, sk, Y[239:255])
    3737 *
    3838 * Message 3 (Session Confirm A):
    39  *  E(sz+Alice.identity+tsA+padding+S(X+Y+Bob.identHash+tsA+tsB), sk, hX_xor_Bob.identHash[16:31])--->
     39 *  E(sz+Alice.identity+tsA+padding+S(X+Y+Bob.identHash+tsA+tsB), sk, hX_xor_Bob.identHash[16:31])---&gt;
    4040 *
    4141 * Message 4 (Session Confirm B):
    42  *  <----------------------E(S(X+Y+Alice.identHash+tsA+tsB)+padding, sk, prev)
     42 *  &lt;----------------------E(S(X+Y+Alice.identHash+tsA+tsB)+padding, sk, prev)
    4343 *
    4444 *  Key:
  • router/java/src/net/i2p/router/transport/udp/PacketBuilder.java

    rdc5bfb2 reefb36c  
    223223     *  This doesn't leave anything for acks.
    224224     *
    225      *  @param numFragments >= 1
     225     *  @param numFragments &gt;= 1
    226226     *  @since 0.9.16
    227227     */
  • router/java/src/net/i2p/router/transport/udp/PeerState.java

    rdc5bfb2 reefb36c  
    16271627     * Pick one or more messages we want to send and allocate them out of our window
    16281628     * High usage -
    1629      * OutboundMessageFragments.getNextVolley() calls this 2nd, if finishMessages() returned > 0.
     1629     * OutboundMessageFragments.getNextVolley() calls this 2nd, if finishMessages() returned &gt; 0.
    16301630     * TODO combine finishMessages(), allocateSend(), and getNextDelay() so we don't iterate 3 times.
    16311631     *
     
    18581858    /**
    18591859     *  A full ACK was received.
    1860      *  TODO if messages awaiting ack were a HashMap<Long, OutboundMessageState> this would be faster.
     1860     *  TODO if messages awaiting ack were a HashMap&lt;Long, OutboundMessageState&gt; this would be faster.
    18611861     *
    18621862     *  @return true if the message was acked for the first time
  • router/java/src/net/i2p/router/transport/udp/UDPTransport.java

    rdc5bfb2 reefb36c  
    709709     *  The current or configured internal IPv4 port.
    710710     *  UDPEndpoint should always be instantiated (and a random port picked if not configured)
    711      *  before this is called, so the returned value should be > 0
     711     *  before this is called, so the returned value should be &gt; 0
    712712     *  unless the endpoint failed to bind.
    713713     */
     
    720720     *  The current or configured internal port.
    721721     *  UDPEndpoint should always be instantiated (and a random port picked if not configured)
    722      *  before this is called, so the returned value should be > 0
     722     *  before this is called, so the returned value should be &gt; 0
    723723     *  unless the endpoint failed to bind.
    724724     */
     
    904904     * @param from Hash of inbound destination
    905905     * @param ourIP publicly routable IPv4 only
    906      * @param ourPort >= 1024
     906     * @param ourPort &gt;= 1024
    907907     */
    908908    void externalAddressReceived(Hash from, byte ourIP[], int ourPort) {
     
    977977     * @param ourIP MUST have been previously validated with isValid()
    978978     *              IPv4 or IPv6 OK
    979      * @param ourPort >= 1024 or 0 for no change
     979     * @param ourPort &gt;= 1024 or 0 for no change
    980980     */
    981981    private boolean changeAddress(byte ourIP[], int ourPort) {
  • router/java/src/net/i2p/router/tunnel/BatchedPreprocessor.java

    rdc5bfb2 reefb36c  
    3636 * let's look to see if we have somthing that would fit instead
    3737 * by reordering:
    38  *   if (allocated > 0 && msg.getFragment == 0) {
    39  *       for (j = i+1, j < pending.size(); j++) {
     38 *   if (allocated &gt; 0 &amp;&amp; msg.getFragment == 0) {
     39 *       for (j = i+1, j &lt; pending.size(); j++) {
    4040 *           if it will fit and it is fragment 0 {
    4141 *               msg = pending.remove(j)
  • router/java/src/net/i2p/router/tunnel/TunnelDispatcher.java

    rdc5bfb2 reefb36c  
    3434 *  Following tunnels are created by us:
    3535 *
    36  *    Outbound Gateway > 0 hops:
     36 *    Outbound Gateway &gt; 0 hops:
    3737 *       PumpedTunnelGateway
    38  *         BatchedRouterPreprocessor -> OutboundSender -> OutboundReceiver -> OutNetMessagePool
     38 *         BatchedRouterPreprocessor -&gt; OutboundSender -&gt; OutboundReceiver -&gt; OutNetMessagePool
    3939 *
    4040 *    Outbound zero-hop Gateway+Endpoint:
    4141 *       TunnelGatewayZeroHop
    42  *         OutboundMessageDistributor -> OutNetMessagePool
    43  *
    44  *    Inbound Endpoint > 0 hops:
     42 *         OutboundMessageDistributor -&gt; OutNetMessagePool
     43 *
     44 *    Inbound Endpoint &gt; 0 hops:
    4545 *       TunnelParticipant
    46  *        RouterFragmentHandler ->  InboundEndpointProcessor -> InboundMessageDistributor -> InNetMessagePool
     46 *        RouterFragmentHandler -&gt;  InboundEndpointProcessor -&gt; InboundMessageDistributor -&gt; InNetMessagePool
    4747 *
    4848 *    Inbound zero-hop Gateway+Endpoint:
    4949 *       TunnelGatewayZeroHop
    50  *         InboundMessageDistributor -> InNetMessagePool
     50 *         InboundMessageDistributor -&gt; InNetMessagePool
    5151 *
    5252 *
     
    5555 *    Participant (not gateway or endpoint)
    5656 *       TunnelParticipant
    57  *         HopProcessor -> OutNetMessagePool
    58  *
    59  *    Outbound Endpoint > 0 hops:
     57 *         HopProcessor -&gt; OutNetMessagePool
     58 *
     59 *    Outbound Endpoint &gt; 0 hops:
    6060 *       OutboundTunnelEndpoint
    61  *         RouterFragmentHandler -> HopProcessor -> OutboundMessageDistributor -> OutNetMessagePool
    62  *
    63  *    Inbound Gateway > 0 hops:
     61 *         RouterFragmentHandler -&gt; HopProcessor -&gt; OutboundMessageDistributor -&gt; OutNetMessagePool
     62 *
     63 *    Inbound Gateway &gt; 0 hops:
    6464 *       ThrottledPumpedTunnelGateway
    65  *         BatchedRouterPreprocessor -> InboundSender -> InboundGatewayReceiver -> OutNetMessagePool
     65 *         BatchedRouterPreprocessor -&gt; InboundSender -&gt; InboundGatewayReceiver -&gt; OutNetMessagePool
    6666 *
    6767 *</pre>
Note: See TracChangeset for help on using the changeset viewer.