Update javadoc with the truth about peers' internalHostName.

This commit is contained in:
Ray J. Greenwell
2018-01-05 14:36:01 -08:00
parent 4456083bcc
commit ec47182263
2 changed files with 10 additions and 4 deletions
@@ -765,9 +765,12 @@ public abstract class PeerManager
} }
/** /**
* Returns the internal hostname to use when connecting to the specified peer or null if the * Returns the internal hostname <strike>to use when connecting to the specified peer</strike>
* peer is not currently connected to this server. Peers connect to one another via their * or null if the peer is not currently connected to this server.
* internal hostname. Do not publish this data to clients out on the Internets. * <strike>Peers connect to one another via their internal hostname.
* Do not publish this data to clients out on the Internets.</strike>
* NOTE: <b>Peers now use the public host name for connections.</b> This method may be
* deprecated in the future.
*/ */
public String getPeerInternalHostName (String nodeName) public String getPeerInternalHostName (String nodeName)
{ {
@@ -113,7 +113,10 @@ public class PeerNode
} }
/** /**
* Returns the hostname for internal clients to use when connecting to this peer. * Returns the "internal" hostname
* <strike>for internal clients to use when connecting to this peer</strike> which is
* no longer really used. NOTE: <b>Peers now use the public host name for connections.</b>
* This method may be deprecated in the future.
*/ */
public String getInternalHostName () public String getInternalHostName ()
{ {