Changeset 0fb4f6a


Ignore:
Timestamp:
Jun 7, 2013 2:03:36 AM (7 years ago)
Author:
zzz <zzz@…>
Branches:
master
Children:
182fe90
Parents:
ebc5e72
Message:

javadocs

Files:
7 edited

Legend:

Unmodified
Added
Removed
  • core/java/src/net/i2p/data/DataStructure.java

    rebc5e72 r0fb4f6a  
    1717 * Defines the class as a standard object with particular bit representation,
    1818 * exposing methods to read and write that representation.
     19 *<p>
     20 * Do not reuse objects.
     21 * Many of modifying methods contain checks to prevent
     22 * altering a DataStructure after it is initialized. This protects the netdb,
     23 * messages that contain DataStructures,
     24 * caches, and the object itself from simple causes of corruption, by
     25 * throwing IllegalStateExceptions.
     26 * These checks are not necessarily thread-safe, and are not guaranteed
     27 * to catch all possible means of corruption.
     28 * Beware of other avenues of corruption, such as directly modifying data
     29 * stored in byte[] objects.
     30 *</p>
    1931 *
    2032 * @author jrandom
  • core/java/src/net/i2p/data/DatabaseEntry.java

    rebc5e72 r0fb4f6a  
    1313
    1414/**
     15 *<p>
    1516 * Base implementation of common methods for the two data structures
    1617 * that are stored in the netDb, i.e. LeaseSet and RouterInfo.
     
    1920 * This consolidates some common code and makes it easier to
    2021 * implement the NetDB and I2NP without doing instanceof all over the place.
    21  *
     22 *</p><p>
    2223 * DatabaseEntries have a SHA256 hash, a routing key, a timestamp, and
    2324 * signatures.
     25 *</p><p>
     26 * Do not reuse objects.
     27 * Many of the setters and other methods contain checks to prevent
     28 * altering a DatabaseEntry after it is signed. This protects the netdb,
     29 * messages that contain DatabaseEntries,
     30 * and the object itself from simple causes of corruption, by
     31 * throwing IllegalStateExceptions.
     32 * These checks are not necessarily thread-safe, and are not guaranteed
     33 * to catch all possible means of corruption.
     34 * Beware of other avenues of corruption, such as directly modifying data
     35 * stored in byte[] objects.
     36 *</p>
    2437 *
    2538 * @author zzz
  • core/java/src/net/i2p/package.html

    rebc5e72 r0fb4f6a  
    44            Core I2P package, contains information about the I2P version and an entry point to access important elements.
    55        </p>
     6<p>
     7With a few exceptions,
     8this package and all others in i2p.jar are maintained as a stable API for use
     9by apps, clients, and plugins.
     10</p>
    611    </body>
    712</html>
  • core/java/src/net/metanotion/package.html

    rebc5e72 r0fb4f6a  
    1010        </head>
    1111        <body>
     12<p>
     13I2P Notes:
     14This is the database used by the BlockfileNamingService class.
     15It is heavily modified from the original 0.1.1 version.
     16Not for direct use by apps, clients, or plugins.
     17This package is not currently intended for general use, as
     18the API may be subject to change.
     19Contact I2P developers if you are considering use in another application.
     20Following is the original documentation copied from metanotion website.
     21</p>
    1222                <h1>Metanotion BlockFile Database</h1>
    1323                <p>A 100% Java 1.3, BSD Licensed, embeddable single file database engine in 32KB. This database was designed for PDA based and J2ME applications.</p>
  • router/java/src/net/i2p/data/i2np/package.html

    rebc5e72 r0fb4f6a  
    11<html><body>
     2<p>
     3This package defines the low-level messages sent between routers,
     4called the Invisible Internet Network Protocol (I2NP).
     5</p>
     6<p>
     7Not for use by apps, clients or plugins.
     8</p>
    29<p>
    310The Invisible Internet Network Protocol (I2NP) is only a part of how an
  • router/java/src/net/i2p/router/package.html

    rebc5e72 r0fb4f6a  
    77            It encompasses sending and receiving messages, building up tunnels, encrypting and decrypting (on multiple levels) where applicable, and so on.
    88        </p>
     9<p>
     10Classes in this package, sub-packages, and others in router.jar are
     11not for use by apps, clients or plugins (except for routerconsole).
     12Subject to change. Not necessarily maintained as a stable API.
     13</p>
    914    </body>
    1015</html>
  • router/java/src/net/i2p/router/util/package.html

    rebc5e72 r0fb4f6a  
    44throughout the router.
    55</p>
     6<p>
     7Not for use by apps, clients or plugins.
     8Subject to change. Not necessarily maintained as a stable API.
     9</p>
    610</body></html>
Note: See TracChangeset for help on using the changeset viewer.