Changeset 252f1047


Ignore:
Timestamp:
Jul 14, 2011 6:53:58 PM (9 years ago)
Author:
zzz <zzz@…>
Branches:
master
Children:
79ac955
Parents:
9f433b2e
Message:

javadocs and final

Location:
core/java/src/net/i2p/client
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • core/java/src/net/i2p/client/I2PClient.java

    r9f433b2e r252f1047  
    4545     * the router how to handle the new session, and to configure the end to end
    4646     * encryption.
    47      * @param destKeyStream location from which to read the Destination, PrivateKey, and SigningPrivateKey from
     47     *
     48     * @param destKeyStream location from which to read the Destination, PrivateKey, and SigningPrivateKey from,
     49     *                      format is specified in {@link net.i2p.data.PrivateKeyFile PrivateKeyFile}
    4850     * @param options set of options to configure the router with, if null will use System properties
    4951     * @return new session allowing a Destination to recieve all of its messages and send messages to any other Destination.
     
    5355    /** Create a new destination with the default certificate creation properties and store
    5456     * it, along with the private encryption and signing keys at the specified location
     57     *
    5558     * @param destKeyStream create a new destination and write out the object to the given stream,
    5659     *                      formatted as Destination, PrivateKey, and SigningPrivateKey
     60     *                      format is specified in {@link net.i2p.data.PrivateKeyFile PrivateKeyFile}
    5761     * @return new destination
    5862     */
     
    6266     * encryption and signing keys at the specified location
    6367     *
    64      * @param destKeyStream location to write out the destination, PrivateKey, and SigningPrivateKey
     68     * @param destKeyStream location to write out the destination, PrivateKey, and SigningPrivateKey,
     69     *                      format is specified in {@link net.i2p.data.PrivateKeyFile PrivateKeyFile}
    6570     * @param cert certificate to tie to the destination
    6671     * @return newly created destination
  • core/java/src/net/i2p/client/I2PClientImpl.java

    r9f433b2e r252f1047  
    3131 */
    3232class I2PClientImpl implements I2PClient {
     33
    3334    /**
    3435     * Create the destination with a null payload
     36     *
     37     * @param destKeyStream location to write out the destination, PrivateKey, and SigningPrivateKey,
     38     *                      format is specified in {@link net.i2p.data.PrivateKeyFile PrivateKeyFile}
    3539     */
    3640    public Destination createDestination(OutputStream destKeyStream) throws I2PException, IOException {
     
    4549     * the PrivateKey and SigningPrivateKey to the destKeyStream
    4650     *
     51     * @param destKeyStream location to write out the destination, PrivateKey, and SigningPrivateKey,
     52     *                      format is specified in {@link net.i2p.data.PrivateKeyFile PrivateKeyFile}
    4753     */
    4854    public Destination createDestination(OutputStream destKeyStream, Certificate cert) throws I2PException, IOException {
     
    6874    /**
    6975     * Create a new session (though do not connect it yet)
     76     *
     77     * @param destKeyStream location from which to read the Destination, PrivateKey, and SigningPrivateKey from,
     78     *                      format is specified in {@link net.i2p.data.PrivateKeyFile PrivateKeyFile}
    7079     * @param options set of options to configure the router with, if null will use System properties
    7180     */
     
    7382        return createSession(I2PAppContext.getGlobalContext(), destKeyStream, options);
    7483    }
     84
    7585    /**
    7686     * Create a new session (though do not connect it yet)
     87     *
     88     * @param destKeyStream location from which to read the Destination, PrivateKey, and SigningPrivateKey from,
     89     *                      format is specified in {@link net.i2p.data.PrivateKeyFile PrivateKeyFile}
    7790     * @param options set of options to configure the router with, if null will use System properties
    7891     */
  • core/java/src/net/i2p/client/I2PSession.java

    r9f433b2e r252f1047  
    218218    public int[] bandwidthLimits() throws I2PSessionException;
    219219
    220     /** See I2PSessionMuxedImpl for details */
     220    /**
     221     *  Listen on specified protocol and port.
     222     *
     223     *  An existing listener with the same proto and port is replaced.
     224     *  Only the listener with the best match is called back for each message.
     225     *
     226     *  @param proto 1-254 or PROTO_ANY (0) for all; recommended:
     227     *         I2PSession.PROTO_STREAMING
     228     *         I2PSession.PROTO_DATAGRAM
     229     *         255 disallowed
     230     *  @param port 1-65535 or PORT_ANY (0) for all
     231     *  @since 0.7.1
     232     */
    221233    public void addSessionListener(I2PSessionListener lsnr, int proto, int port);
    222     /** See I2PSessionMuxedImpl for details */
     234
     235    /**
     236     *  Listen on specified protocol and port, and receive notification
     237     *  of proto, fromPort, and toPort for every message.
     238     *  @param proto 1-254 or PROTO_ANY (0) for all; 255 disallowed
     239     *  @param port 1-65535 or PORT_ANY (0) for all
     240     *  @since 0.7.1
     241     */
    223242    public void addMuxedSessionListener(I2PSessionMuxedListener l, int proto, int port);
    224     /** See I2PSessionMuxedImpl for details */
     243
     244    /**
     245     *  removes the specified listener (only)
     246     *  @since 0.7.1
     247     */
    225248    public void removeListener(int proto, int port);
    226249
  • core/java/src/net/i2p/client/I2PSessionDemultiplexer.java

    r9f433b2e r252f1047  
    1717 * protocol, from port, and to port for every received message.
    1818 *
    19  * This only calls one listener, not all that apply.
     19 * messageAvailable() only calls one listener, not all that apply.
     20 * The others call all listeners.
    2021 *
    2122 * @author zzz
    2223 */
    2324public class I2PSessionDemultiplexer implements I2PSessionMuxedListener {
    24     private Log _log;
    25     private Map<Integer, I2PSessionMuxedListener> _listeners;
     25    private final Log _log;
     26    private final Map<Integer, I2PSessionMuxedListener> _listeners;
    2627
    2728    public I2PSessionDemultiplexer(I2PAppContext ctx) {
  • core/java/src/net/i2p/client/I2PSessionImpl.java

    r9f433b2e r252f1047  
    160160     * from the destKeyStream, and using the specified options to connect to the router
    161161     *
     162     * @param destKeyStream stream containing the private key data,
     163     *                             format is specified in {@link net.i2p.data.PrivateKeyFile PrivateKeyFile}
    162164     * @param options set of options to configure the router with, if null will use System properties
    163165     * @throws I2PSessionException if there is a problem loading the private keys or
  • core/java/src/net/i2p/client/I2PSessionImpl2.java

    r9f433b2e r252f1047  
    5050     * from the destKeyStream, and using the specified options to connect to the router
    5151     *
     52     * @param destKeyStream stream containing the private key data,
     53     *                             format is specified in {@link net.i2p.data.PrivateKeyFile PrivateKeyFile}
    5254     * @param options set of options to configure the router with, if null will use System properties
    5355     * @throws I2PSessionException if there is a problem loading the private keys or
  • core/java/src/net/i2p/client/I2PSessionMuxedImpl.java

    r9f433b2e r252f1047  
    6666 */
    6767class I2PSessionMuxedImpl extends I2PSessionImpl2 implements I2PSession {
    68     private I2PSessionDemultiplexer _demultiplexer;
     68
     69    private final I2PSessionDemultiplexer _demultiplexer;
    6970
    7071    /*
     72     * @param destKeyStream stream containing the private key data,
     73     *                             format is specified in {@link net.i2p.data.PrivateKeyFile PrivateKeyFile}
    7174     * @param options set of options to configure the router with, if null will use System properties
    7275     */
     
    9396     *  Only the listener with the best match is called back for each message.
    9497     *
    95      *  @param proto 1-254 or PROTO_ANY for all; recommended:
     98     *  @param proto 1-254 or PROTO_ANY (0) for all; recommended:
    9699     *         I2PSession.PROTO_STREAMING
    97100     *         I2PSession.PROTO_DATAGRAM
    98101     *         255 disallowed
    99      *  @param port 1-65535 or PORT_ANY for all
     102     *  @param port 1-65535 or PORT_ANY (0) for all
    100103     */
    101104    @Override
     
    107110     *  Listen on specified protocol and port, and receive notification
    108111     *  of proto, fromPort, and toPort for every message.
    109      *  @param proto 1-254 or 0 for all; 255 disallowed
    110      *  @param port 1-65535 or 0 for all
     112     *  @param proto 1-254 or PROTO_ANY (0) for all; 255 disallowed
     113     *  @param port 1-65535 or PORT_ANY (0) for all
    111114     */
    112115    @Override
Note: See TracChangeset for help on using the changeset viewer.