fix: warnings when generating javadoc
This commit is contained in:
@ -222,7 +222,7 @@ on the client socket : all remaining data passing through the
|
|||||||
current socket is forwarded from and to the connected I2P destination
|
current socket is forwarded from and to the connected I2P destination
|
||||||
peer.
|
peer.
|
||||||
* If SILENCE=false was passed, which is the default value, the SAM bridge
|
* If SILENCE=false was passed, which is the default value, the SAM bridge
|
||||||
sends the client a ASCII line containing the base64 public destination key
|
sends the client an ASCII line containing the base64 public destination key
|
||||||
of the requesting peer. After this '\n' terminated line, all remaining data
|
of the requesting peer. After this '\n' terminated line, all remaining data
|
||||||
passing through the current socket is forwarded from and to the connected
|
passing through the current socket is forwarded from and to the connected
|
||||||
I2P destination peer, until one of the peer closes the socket.
|
I2P destination peer, until one of the peer closes the socket.
|
||||||
|
@ -54,11 +54,10 @@ public interface SAMStreamReceiver {
|
|||||||
public void notifyStreamOutgoingConnection(int id, String result, String msg) throws IOException;
|
public void notifyStreamOutgoingConnection(int id, String result, String msg) throws IOException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Send a byte array to a SAM client.
|
* Transmit a byte array from I2P to a SAM client.
|
||||||
*
|
*
|
||||||
* @param id Connection id
|
* @param id Connection id
|
||||||
* @param data Byte array to be received
|
* @param data Byte array to be received
|
||||||
* @param len Number of bytes in data
|
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
*/
|
*/
|
||||||
public void receiveStreamBytes(int id, ByteBuffer data) throws IOException;
|
public void receiveStreamBytes(int id, ByteBuffer data) throws IOException;
|
||||||
|
@ -30,8 +30,9 @@ public class SAMv3DatagramSession extends SAMDatagramSession implements SAMv3Han
|
|||||||
public String getNick() { return nick; }
|
public String getNick() { return nick; }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* build a DatagramSession according to informations registered
|
||||||
|
* with the given nickname
|
||||||
* @param nick nickname of the session
|
* @param nick nickname of the session
|
||||||
* @param server DatagramServer used for communication with the client
|
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
* @throws DataFormatException
|
* @throws DataFormatException
|
||||||
* @throws I2PSessionException
|
* @throws I2PSessionException
|
||||||
|
@ -29,8 +29,10 @@ public class SAMv3RawSession extends SAMRawSession implements SAMv3Handler.Sess
|
|||||||
public String getNick() { return nick; }
|
public String getNick() { return nick; }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Build a Raw Datagram Session according to information
|
||||||
|
* registered with the given nickname
|
||||||
|
*
|
||||||
* @param nick nickname of the session
|
* @param nick nickname of the session
|
||||||
* @param server DatagramServer used for communication with the client
|
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
* @throws DataFormatException
|
* @throws DataFormatException
|
||||||
* @throws I2PSessionException
|
* @throws I2PSessionException
|
||||||
|
@ -55,12 +55,10 @@ public class SAMv3StreamSession extends SAMStreamSession implements SAMv3Handle
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a new SAM STREAM session.
|
* Create a new SAM STREAM session, according to information
|
||||||
|
* registered with the given nickname
|
||||||
*
|
*
|
||||||
* @param dest Base64-encoded destination (private key)
|
* @param login The nickname
|
||||||
* @param dir Session direction ("RECEIVE", "CREATE" or "BOTH")
|
|
||||||
* @param props Properties to setup the I2P session
|
|
||||||
* @param recv Object that will receive incoming data
|
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
* @throws DataFormatException
|
* @throws DataFormatException
|
||||||
* @throws SAMException
|
* @throws SAMException
|
||||||
@ -116,11 +114,10 @@ public class SAMv3StreamSession extends SAMStreamSession implements SAMv3Handle
|
|||||||
/**
|
/**
|
||||||
* Connect the SAM STREAM session to the specified Destination
|
* Connect the SAM STREAM session to the specified Destination
|
||||||
*
|
*
|
||||||
* @param id Unique id for the connection
|
* @param handler The handler that communicates with the requesting client
|
||||||
* @param dest Base64-encoded Destination to connect to
|
* @param dest Base64-encoded Destination to connect to
|
||||||
* @param props Options to be used for connection
|
* @param props Options to be used for connection
|
||||||
*
|
*
|
||||||
* @return true if successful
|
|
||||||
* @throws DataFormatException if the destination is not valid
|
* @throws DataFormatException if the destination is not valid
|
||||||
* @throws ConnectException if the destination refuses connections
|
* @throws ConnectException if the destination refuses connections
|
||||||
* @throws NoRouteToHostException if the destination can't be reached
|
* @throws NoRouteToHostException if the destination can't be reached
|
||||||
@ -128,7 +125,9 @@ public class SAMv3StreamSession extends SAMStreamSession implements SAMv3Handle
|
|||||||
* @throws I2PException if there's another I2P-related error
|
* @throws I2PException if there's another I2P-related error
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
*/
|
*/
|
||||||
public void connect ( SAMv3Handler handler, String dest, Properties props ) throws I2PException, ConnectException, NoRouteToHostException, DataFormatException, InterruptedIOException, IOException {
|
public void connect ( SAMv3Handler handler, String dest, Properties props )
|
||||||
|
throws I2PException, ConnectException, NoRouteToHostException,
|
||||||
|
DataFormatException, InterruptedIOException, IOException {
|
||||||
|
|
||||||
boolean verbose = (props.getProperty("SILENT", "false").equals("false"));
|
boolean verbose = (props.getProperty("SILENT", "false").equals("false"));
|
||||||
Destination d = SAMUtils.getDest(dest);
|
Destination d = SAMUtils.getDest(dest);
|
||||||
@ -164,11 +163,11 @@ public class SAMv3StreamSession extends SAMStreamSession implements SAMv3Handle
|
|||||||
/**
|
/**
|
||||||
* Accept an incoming STREAM
|
* Accept an incoming STREAM
|
||||||
*
|
*
|
||||||
* @param id Unique id for the connection
|
* @param handler The handler that communicates with the requesting client
|
||||||
* @param dest Base64-encoded Destination to connect to
|
* @param verbose If true, SAM will send the Base64-encoded peer Destination of an
|
||||||
* @param props Options to be used for connection
|
* incoming socket as the first line of data sent to its client
|
||||||
|
* on the handler socket
|
||||||
*
|
*
|
||||||
* @return true if successful
|
|
||||||
* @throws DataFormatException if the destination is not valid
|
* @throws DataFormatException if the destination is not valid
|
||||||
* @throws ConnectException if the destination refuses connections
|
* @throws ConnectException if the destination refuses connections
|
||||||
* @throws NoRouteToHostException if the destination can't be reached
|
* @throws NoRouteToHostException if the destination can't be reached
|
||||||
@ -369,7 +368,6 @@ public class SAMv3StreamSession extends SAMStreamSession implements SAMv3Handle
|
|||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* stop Forwarding Incoming connection coming from I2P
|
* stop Forwarding Incoming connection coming from I2P
|
||||||
* @param props
|
|
||||||
* @throws SAMException
|
* @throws SAMException
|
||||||
* @throws InterruptedIOException
|
* @throws InterruptedIOException
|
||||||
*/
|
*/
|
||||||
|
Reference in New Issue
Block a user