Changeset 2c1b9c2


Ignore:
Timestamp:
Dec 12, 2015 2:31:52 PM (4 years ago)
Author:
zzz <zzz@…>
Branches:
master
Children:
68ecd82
Parents:
cddc1b3
Message:

Javadoc fixes
Better OCMOSJ Javadocs

Files:
5 edited

Legend:

Unmodified
Added
Removed
  • apps/sam/java/src/net/i2p/sam/SAMBridge.java

    rcddc1b3 r2c1b9c2  
    360360     *
    361361     * @param props non-null instantiate and start server if it doesn't exist
    362      * @param return non-null
     362     * @return non-null
    363363     * @throws IOException if can't bind to host/port, or if different than existing
    364364     * @since 0.9.24
  • router/java/src/net/i2p/router/StatisticsManager.java

    rcddc1b3 r2c1b9c2  
    6464     *  This includes all standard options (as of 0.9.24, network ID and caps)
    6565     *
    66      *  @param current router hash, non-null
     66     *  @param h current router hash, non-null
    6767     *  @since 0.9.24
    6868     */
  • router/java/src/net/i2p/router/message/OutboundClientMessageOneShotJob.java

    rcddc1b3 r2c1b9c2  
    3939
    4040/**
    41  * Send a client message out a random outbound tunnel and into a random inbound
     41 * Send a client message out an outbound tunnel and into an inbound
    4242 * tunnel on the target leaseSet.  This also (sometimes) bundles the sender's leaseSet and
    4343 * a DeliveryStatusMessage (for ACKing any sessionTags used in the garlic).
     44 *
     45 * <p>
     46 * This class is where we make several important decisions about
     47 * what to send and what path to send it over. These decisions
     48 * will dramatically affect:
     49 * <ul>
     50 * <li>Local performance and outbound bandwidth usage
     51 * <li>Streaming performance and reliability
     52 * <li>Overall network performace and connection congestion
     53 * </ul>
     54 *
     55 * <p>
     56 * For the outbound message, we build and encrypt a garlic message,
     57 * after making the following decisions:
     58 * <ul>
     59 * <li>Whether to bundle our leaseset
     60 * <li>Whether to bundle session tags, and if so, how many
     61 * <li>Whether to bundle an encrypted DeliveryStatusMessage to be returned
     62 *     to us as an acknowledgement
     63 * </ul>
     64 *
     65 * <p>
     66 * Also, we make the following path selection decisions:
     67 * <ul>
     68 * <li>What outbound client tunnel of ours to use send the message out
     69 * <li>What inbound client tunnel of his (i.e. lease, chosen from his leaseset)
     70 *     to use to send the message in
     71 * <li>If a DeliveryStatusMessage is bundled, What inbound client tunnel of ours
     72 *     do we specify to receive it
     73 * </ul>
     74 *
     75 * <p>
     76 * Note that the 4th tunnel in the DeliveryStatusMessage's round trip (his outbound tunnel)
     77 * is not selected by us, it is chosen by the recipient.
     78 *
     79 * <p>
     80 * If a DeliveryStatusMessage is sent, a listener is registered to wait for its reply.
     81 * When a reply is received, or the timeout is reached, this is noted
     82 * and will influence subsequent bundling and path selection decisions.
     83 *
     84 * <p>
     85 * Path selection decisions are cached and reused if still valid and if
     86 * previous deliveries were apparently successful. This significantly
     87 * reduces out-of-order delivery and network connection congestion.
     88 * Caching is based on the local/remote destination pair.
     89 *
     90 * <p>
     91 * Bundling decisions, and both messaging and reply expiration times, are generally
     92 * set here but may be overridden by the client on a per-message basis.
     93 * Within clients, there may be overall settings or per-message settings.
     94 * The streaming lib also overrides defaults for some messages.
     95 * A datagram-based DHT application may need significantly different
     96 * settings than a streaming application. For an application such as
     97 * a bittorrent client that sends both types of traffic on the same tunnels,
     98 * it is important to tune the settings for efficiency and performance.
     99 * The per-session and per-message overrides are set via I2CP.
     100 *
    44101 *
    45102 */
  • router/java/src/net/i2p/router/transport/udp/OutboundEstablishState.java

    rcddc1b3 r2c1b9c2  
    110110     *  @param remoteHostId non-null, == claimedAddress if direct, or a hash-based one if indirect
    111111     *  @param remotePeer must have supported sig type
    112      *  @param allowExtenededOptions are we allowed to send extended options to Bob?
     112     *  @param allowExtendedOptions are we allowed to send extended options to Bob?
    113113     *  @param needIntroduction should we ask Bob to be an introducer for us?
    114114               ignored unless allowExtendedOptions is true
  • router/java/src/net/i2p/router/tunnel/TunnelCreatorConfig.java

    rcddc1b3 r2c1b9c2  
    153153    /**
    154154     *  This calls profile manager tunnelDataPushed1m() for each peer
    155      *  @return null for exploratory
    156155     */
    157156    public synchronized void incrementVerifiedBytesTransferred(int bytes) {
Note: See TracChangeset for help on using the changeset viewer.