forked from I2P_Developers/i2p.i2p
javadoc fixes part 9 (ticket #1894)
This commit is contained in:
@@ -26,7 +26,7 @@ public class I2PSocketAddress extends SocketAddress {
|
||||
* Does a naming service lookup to resolve the dest.
|
||||
* May take several seconds for b32.
|
||||
* @param host hostname or b64 dest or b32, may have :port appended
|
||||
* @throws IllegalArgumentException for port < 0 or port > 65535 or invalid port
|
||||
* @throws IllegalArgumentException for port < 0 or port > 65535 or invalid port
|
||||
* @since 0.9.9
|
||||
*/
|
||||
public I2PSocketAddress(String host) {
|
||||
@@ -51,7 +51,7 @@ public class I2PSocketAddress extends SocketAddress {
|
||||
|
||||
/**
|
||||
* Does not do a reverse lookup. Host will be null.
|
||||
* @throws IllegalArgumentException for port < 0 or port > 65535
|
||||
* @throws IllegalArgumentException for port < 0 or port > 65535
|
||||
*/
|
||||
public I2PSocketAddress(Destination dest, int port) {
|
||||
if (dest == null)
|
||||
@@ -66,7 +66,7 @@ public class I2PSocketAddress extends SocketAddress {
|
||||
/**
|
||||
* Does a naming service lookup to resolve the dest.
|
||||
* May take several seconds for b32.
|
||||
* @throws IllegalArgumentException for port < 0 or port > 65535
|
||||
* @throws IllegalArgumentException for port < 0 or port > 65535
|
||||
*/
|
||||
public I2PSocketAddress(String host, int port) {
|
||||
if (port < 0 || port > 65535)
|
||||
@@ -77,7 +77,7 @@ public class I2PSocketAddress extends SocketAddress {
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws IllegalArgumentException for port < 0 or port > 65535
|
||||
* @throws IllegalArgumentException for port < 0 or port > 65535
|
||||
*/
|
||||
public static I2PSocketAddress createUnresolved(String host, int port) {
|
||||
return new I2PSocketAddress(port, host);
|
||||
|
||||
@@ -32,7 +32,7 @@ public class I2PSocketException extends SocketException {
|
||||
* Standard codes from client-side I2CP are 256-511, defined in SendMessageStatusListener.
|
||||
* Standard codes from streaming are 512-767, defined here.
|
||||
*
|
||||
* @param status >= 0 from MessageStatusMessage or SendMessageStatusListener
|
||||
* @param status >= 0 from MessageStatusMessage or SendMessageStatusListener
|
||||
*/
|
||||
public I2PSocketException(int status) {
|
||||
super();
|
||||
|
||||
@@ -240,7 +240,7 @@ public interface I2PSocketManager {
|
||||
/**
|
||||
* Like connect() but returns a real Socket, and throws only IOE,
|
||||
* for easier porting of apps.
|
||||
* @param timeout ms if > 0, forces blocking (disables connectDelay)
|
||||
* @param timeout ms if > 0, forces blocking (disables connectDelay)
|
||||
* @since 0.8.4
|
||||
*/
|
||||
public Socket connectToSocket(Destination peer, int timeout) throws IOException;
|
||||
|
||||
@@ -80,7 +80,7 @@ public class I2PSocketManagerFactory {
|
||||
* The nonblocking createDisconnectedManager() is preferred.
|
||||
*
|
||||
* @param host I2CP host null to use default, ignored if in router context
|
||||
* @param port I2CP port <= 0 to use default, ignored if in router context
|
||||
* @param port I2CP port <= 0 to use default, ignored if in router context
|
||||
* @return the newly created socket manager, or null if there were errors
|
||||
*/
|
||||
public static I2PSocketManager createManager(String host, int port) {
|
||||
@@ -95,7 +95,7 @@ public class I2PSocketManagerFactory {
|
||||
* The nonblocking createDisconnectedManager() is preferred.
|
||||
*
|
||||
* @param i2cpHost I2CP host null to use default, ignored if in router context
|
||||
* @param i2cpPort I2CP port <= 0 to use default, ignored if in router context
|
||||
* @param i2cpPort I2CP port <= 0 to use default, ignored if in router context
|
||||
* @param opts Streaming and I2CP options, may be null
|
||||
* @return the newly created socket manager, or null if there were errors
|
||||
*/
|
||||
@@ -157,7 +157,7 @@ public class I2PSocketManagerFactory {
|
||||
* @param myPrivateKeyStream private key stream, format is specified in {@link net.i2p.data.PrivateKeyFile PrivateKeyFile}
|
||||
* or null for a transient destination. Caller must close.
|
||||
* @param i2cpHost I2CP host null to use default, ignored if in router context
|
||||
* @param i2cpPort I2CP port <= 0 to use default, ignored if in router context
|
||||
* @param i2cpPort I2CP port <= 0 to use default, ignored if in router context
|
||||
* @param opts Streaming and I2CP options, may be null
|
||||
* @return the newly created socket manager, or null if there were errors
|
||||
*/
|
||||
@@ -184,7 +184,7 @@ public class I2PSocketManagerFactory {
|
||||
* @param myPrivateKeyStream private key stream, format is specified in {@link net.i2p.data.PrivateKeyFile PrivateKeyFile}
|
||||
* or null for a transient destination. Caller must close.
|
||||
* @param i2cpHost I2CP host null to use default, ignored if in router context
|
||||
* @param i2cpPort I2CP port <= 0 to use default, ignored if in router context
|
||||
* @param i2cpPort I2CP port <= 0 to use default, ignored if in router context
|
||||
* @param opts Streaming and I2CP options, may be null
|
||||
* @return the newly created socket manager, non-null (throws on error)
|
||||
* @since 0.9.8
|
||||
@@ -216,7 +216,7 @@ public class I2PSocketManagerFactory {
|
||||
* @param myPrivateKeyStream private key stream, format is specified in {@link net.i2p.data.PrivateKeyFile PrivateKeyFile}
|
||||
* non-null. Caller must close.
|
||||
* @param i2cpHost I2CP host null to use default, ignored if in router context
|
||||
* @param i2cpPort I2CP port <= 0 to use default, ignored if in router context
|
||||
* @param i2cpPort I2CP port <= 0 to use default, ignored if in router context
|
||||
* @param opts Streaming and I2CP options, may be null
|
||||
* @param connect true to connect (blocking)
|
||||
* @return the newly created socket manager, non-null (throws on error)
|
||||
|
||||
@@ -18,7 +18,7 @@ public interface I2PSocketOptions {
|
||||
* How long we will wait for the ACK from a SYN, in milliseconds.
|
||||
*
|
||||
* Default 60 seconds. Max of 2 minutes enforced in Connection.java,
|
||||
* and it also interprets <= 0 as default.
|
||||
* and it also interprets <= 0 as default.
|
||||
*
|
||||
* @return milliseconds to wait, or -1 if we will wait indefinitely
|
||||
*/
|
||||
@@ -28,7 +28,7 @@ public interface I2PSocketOptions {
|
||||
* Define how long we will wait for the ACK from a SYN, in milliseconds.
|
||||
*
|
||||
* Default 60 seconds. Max of 2 minutes enforced in Connection.java,
|
||||
* and it also interprets <= 0 as default.
|
||||
* and it also interprets <= 0 as default.
|
||||
*
|
||||
* @param ms timeout in ms
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user