Changeset 3f990b0


Ignore:
Timestamp:
Mar 29, 2019 12:42:45 PM (16 months ago)
Author:
zab2 <zab2@…>
Branches:
master
Children:
956a714
Parents:
3dbe8f20
Message:

html in javadoc

File:
1 edited

Legend:

Unmodified
Added
Removed
  • apps/i2ptunnel/java/src/net/i2p/i2ptunnel/access/DefinitionParser.java

    r3dbe8f20 r3f990b0  
    4343     * The threshold format can be one of the following:
    4444     *
    45      * * Numeric definition of number of connections over number minutes - "15/5",
     45     * <ul>
     46     * <li>Numeric definition of number of connections over number minutes - "15/5",
    4647     *   "30/60", and so on.  Note that if the number of connections is 1 (as for
    47      *   example in "1/1") the first connection attempt will result in a breach.
    48      * * The word "allow".  This threshold is never breached, i.e. infinite number of
    49      *   connection attempts is permitted.
    50      * * The word "deny".  This threshold is always breached, i.e. no connection attempts
    51      *   will be allowed.
     48     *   example in "1/1") the first connection attempt will result in a breach.</li>
     49     * <li>The word "allow".  This threshold is never breached, i.e. infinite number of
     50     *   connection attempts is permitted.</li>
     51     * <li>The word "deny".  This threshold is always breached, i.e. no connection attempts
     52     *   will be allowed.</li>
     53     * </ul>
    5254     *
    5355     * Default threshold
     
    5759     * threshold use the keyword "default".  The following are examples of default thresholds:
    5860     *
    59      * -----------------------------
     61     * <pre>
    6062     * default 15/5
    6163     * default allow
    6264     * default deny
    63      * -----------------------------
     65     * </pre>
    6466     *
    6567     * Explicit thresholds
     
    6870     * Examples:
    6971     *
    70      * -----------------------------
     72     * <pre>
    7173     * 15/5 explicit asdfasdfasdf.b32.i2p
    7274     * allow explicit fdsafdsafdsa.b32.i2p
    7375     * deny explicit qwerqwerqwer.b32.i2p
    74      * -----------------------------
     76     * </pre>
    7577     *
    7678     * Thresholds for destinations listed in a file
     
    7981     * a threshold for all of them in bulk.  Examples:
    8082     *
    81      * -----------------------------
     83     * <pre>
    8284     * 15/5 file /path/throttled_destinations.txt
    8385     * deny file /path/forbidden_destinations.txt
    8486     * allow file /path/unlimited_destinations.txt
    85      * -----------------------------
     87     * </pre>
    8688     *
    8789     * Recorders
     
    9092     * breaches a certain threshold, that destination gets recorded in a given file.  Examples:
    9193     *
    92      * -----------------------------
     94     * <pre>
    9395     * recorder 30/5 /path/aggressive.txt
    9496     * recorder 60/5 /path/very_aggressive.txt
    95      * -----------------------------
     97     * </pre>
    9698     *
    9799     * It is possible to use a recorder to record aggressive destinations to a given file,
     
    101103     * 5 minutes:
    102104     *
    103      * -----------------------------
     105     * <pre>
    104106     * # by default there are no limits
    105107     * default allow
     
    108110     * # and any that end up in that file will get throttled in the future
    109111     * 15/5 file /path/throttled.txt
    110      * -----------------------------
     112     * </pre>
    111113     *
    112114     * It is possible to use a recorder in one tunnel that writes to a file that throttles
     
    119121     * "suspicious.txt":
    120122     *
    121      * -----------------------------
     123     * <pre>
    122124     * default 15/5
    123125     * allow file /path/friends.txt
    124126     * deny file /path/enemies.txt
    125127     * recorder 60/5 /path/suspicious.txt
    126      * -----------------------------
     128     * </pre>
    127129     *
    128130     * @return a FilterDefinition POJO representation for internal use
Note: See TracChangeset for help on using the changeset viewer.