net.i2p.router.transport.CommSystemFacadeImpl

All Implemented Interfaces:: Service

public class CommSystemFacadeImpl
extends CommSystemFacade

Nested Class Summary

Nested classes/interfaces inherited from class net.i2p.router.CommSystemFacade
CommSystemFacade.Status
Field Summary

Fields inherited from class net.i2p.router.CommSystemFacade
ROUTER_BUNDLE_NAME, STATUS_DIFFERENT, STATUS_DISCONNECTED, STATUS_HOSED, STATUS_IPV4_DISABLED_IPV6_FIREWALLED, STATUS_IPV4_DISABLED_IPV6_OK, STATUS_IPV4_DISABLED_IPV6_UNKNOWN, STATUS_IPV4_FIREWALLED_IPV6_OK, STATUS_IPV4_FIREWALLED_IPV6_UNKNOWN, STATUS_IPV4_OK_IPV6_FIREWALLED, STATUS_IPV4_OK_IPV6_UNKNOWN, STATUS_IPV4_SNAT_IPV6_OK, STATUS_IPV4_SNAT_IPV6_UNKNOWN, STATUS_IPV4_UNKNOWN_IPV6_FIREWALLED, STATUS_IPV4_UNKNOWN_IPV6_OK, STATUS_OK, STATUS_REJECT_UNSOLICITED, STATUS_UNKNOWN
Constructor Summary

Constructors

Constructor Description

CommSystemFacadeImpl(RouterContext context)

Method Summary

Modifier and Type	Method	Description
`int`	`countActivePeers()`	How many peers are we currently connected to, that we have sent a message to or received a message from in the last minute.
`int`	`countActiveSendPeers()`	How many peers are we currently connected to, that we have sent a message to in the last minute.
`List<RouterAddress>`	`createAddresses()`	Create the list of RouterAddress structures based on the router's config
`void`	`forceDisconnect(Hash peer)`	Tell the comm system to disconnect from this peer.
`String`	`getCountry(Hash peer)`	Uses the transport IP first because that lookup is fast, then the IP from the netDb.
`String`	`getCountryName(String c)`	full name for a country code, or the code if we don't know the name
`DHSessionKeyBuilder.Factory`	`getDHFactory()`	Hook for pluggable transport creation.
`Set<Hash>`	`getEstablished()`	Get all the peers we are connected to.
`long`	`getFramedAveragePeerClockSkew(int percentToInclude)`	Return framed average clock skew of connected peers in seconds, or null if we cannot answer.
`byte[]`	`getIP(Hash peer)`
`String`	`getLocalizedStatusString()`	getStatus().toStatusString(), translated if available.
`List<String>`	`getMostRecentErrorMessages()`
`String`	`getOurCountry()`
`CommSystemFacade.Status`	`getStatus()`	Determine under what conditions we are remotely reachable.
`SortedMap<String,Transport>`	`getTransports()`
`static byte[]`	`getValidIP(RouterInfo ri)`	Return first valid IP (v4 or v6) we find, any transport.
`X25519KeyFactory`	`getXDHFactory()`	Factory for making X25519 key pairs.
`boolean`	`haveHighOutboundCapacity()`
`boolean`	`haveInboundCapacity(int pct)`
`boolean`	`haveOutboundCapacity(int pct)`
`void`	`initGeoIP()`	Router must call after netdb is initialized
`boolean`	`isBacklogged(Hash peer)`
`boolean`	`isDummy()`	Is everything disabled for testing?
`boolean`	`isEstablished(Hash peer)`
`boolean`	`isInStrictCountry()`	Are we in a strict country
`boolean`	`isInStrictCountry(Hash peer)`	Are they in a strict country.
`boolean`	`isInStrictCountry(RouterInfo ri)`	Are they in a strict country
`void`	`mayDisconnect(Hash peer)`	Tell the comm system that we may disconnect from this peer.
`void`	`notifyRemoveAddress(boolean ipv6)`	Tell other transports our address changed
`void`	`notifyRemoveAddress(RouterAddress address)`	Tell other transports our address changed
`void`	`notifyReplaceAddress(RouterAddress udpAddr)`	UDP changed addresses, tell NTCP and restart All the work moved to NTCPTransport.externalAddressReceived()
`void`	`processMessage(OutNetMessage msg)`	Send the message out
`void`	`queueLookup(byte[] ip)`
`void`	`recheckReachability()`	Deprecated. unused
`void`	`registerTransport(Transport t)`	Pluggable transports.
`String`	`renderPeerHTML(Hash peer)`	Provide a consistent "look" for displaying router IDs in the console
`void`	`renderStatusHTML(Writer out, String urlBase, int sortFlags)`	As of 0.9.31, only outputs UPnP status Warning - blocking, very slow, queries the active UPnP router, will take many seconds if it has vanished.
`void`	`restart()`	Perform a soft restart.
`void`	`shutdown()`	Cannot be restarted after calling this.
`void`	`startup()`	Instruct the service that it should start normal operation.
`void`	`unregisterTransport(Transport t)`	Pluggable transports.
`boolean`	`wasUnreachable(Hash peer)`

Methods inherited from class net.i2p.router.CommSystemFacade

getMedianPeerClockSkew, getReachabilityStatus, renderStatusHTML

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- CommSystemFacadeImpl
  
  public CommSystemFacadeImpl(RouterContext context)
Method Details
- startup
  
  public void startup()
  
  Description copied from interface: Service
  
  Instruct the service that it should start normal operation. This call DOES block until the service is ready.
- shutdown
  
  public void shutdown()
  
  Cannot be restarted after calling this. Use restart() for that.
- restart
  
  public void restart()
  
  Description copied from interface: Service
  
  Perform a soft restart.
- countActivePeers
  
  public int countActivePeers()
  
  How many peers are we currently connected to, that we have sent a message to or received a message from in the last minute.
  
  Specified by:
  
  countActivePeers in class CommSystemFacade
- countActiveSendPeers
  
  public int countActiveSendPeers()
  
  How many peers are we currently connected to, that we have sent a message to in the last minute. Unused for anything, to be removed.
  
  Specified by:
  
  countActiveSendPeers in class CommSystemFacade
- haveInboundCapacity
  
  public boolean haveInboundCapacity(int pct)
  
  Overrides:
  
  haveInboundCapacity in class CommSystemFacade
- haveOutboundCapacity
  
  public boolean haveOutboundCapacity(int pct)
  
  Overrides:
  
  haveOutboundCapacity in class CommSystemFacade
- haveHighOutboundCapacity
  
  public boolean haveHighOutboundCapacity()
  
  Overrides:
  
  haveHighOutboundCapacity in class CommSystemFacade
- getFramedAveragePeerClockSkew
  
  public long getFramedAveragePeerClockSkew(int percentToInclude)
  
  Description copied from class: CommSystemFacade
  
  Return framed average clock skew of connected peers in seconds, or null if we cannot answer. CommSystemFacadeImpl overrides this.
  
  Overrides:
  
  getFramedAveragePeerClockSkew in class CommSystemFacade
  
  Parameters:
  
  percentToInclude - 1-100
  
  Returns:
  
  Framed average clock skew of connected peers in milliseconds, or the clock offset if we cannot answer. Average is calculated over the middle "percentToInclude" peers. A positive number means our clock is ahead of theirs. Todo: change List to milliseconds
- processMessage
  
  public void processMessage(OutNetMessage msg)
  
  Send the message out
  
  Specified by:
  
  processMessage in class CommSystemFacade
- isBacklogged
  
  public boolean isBacklogged(Hash peer)
  
  Overrides:
  
  isBacklogged in class CommSystemFacade
- isEstablished
  
  public boolean isEstablished(Hash peer)
  
  Specified by:
  
  isEstablished in class CommSystemFacade
- getEstablished
  
  public Set<Hash> getEstablished()
  
  Description copied from class: CommSystemFacade
  
  Get all the peers we are connected to. This should be more efficient than repeated calls to isEstablished() if you have to check a lot.
  
  Specified by:
  
  getEstablished in class CommSystemFacade
  
  Returns:
  
  a new set, may be modified
  
  Since:
  
  0.9.34
- wasUnreachable
  
  public boolean wasUnreachable(Hash peer)
  
  Overrides:
  
  wasUnreachable in class CommSystemFacade
- getIP
  
  public byte[] getIP(Hash peer)
  
  Overrides:
  
  getIP in class CommSystemFacade
- mayDisconnect
  
  public void mayDisconnect(Hash peer)
  
  Tell the comm system that we may disconnect from this peer. This is advisory only.
  
  Overrides:
  
  mayDisconnect in class CommSystemFacade
  
  Since:
  
  0.9.24
- forceDisconnect
  
  public void forceDisconnect(Hash peer)
  
  Tell the comm system to disconnect from this peer.
  
  Overrides:
  
  forceDisconnect in class CommSystemFacade
  
  Since:
  
  0.9.38
- getMostRecentErrorMessages
  
  public List<String> getMostRecentErrorMessages()
  
  Overrides:
  
  getMostRecentErrorMessages in class CommSystemFacade
- getStatus
  
  public CommSystemFacade.Status getStatus()
  
  Description copied from class: CommSystemFacade
  
  Determine under what conditions we are remotely reachable.
  
  Overrides:
  
  getStatus in class CommSystemFacade
  
  Since:
  
  0.9.20
- getLocalizedStatusString
  
  public String getLocalizedStatusString()
  
  getStatus().toStatusString(), translated if available.
  
  Overrides:
  
  getLocalizedStatusString in class CommSystemFacade
  
  Since:
  
  0.9.45
- recheckReachability
  
  @Deprecated public void recheckReachability()
  
  Deprecated.
  unused
  
  Overrides:
  
  recheckReachability in class CommSystemFacade
- renderStatusHTML
  
  public void renderStatusHTML(Writer out, String urlBase, int sortFlags) throws IOException
  
  As of 0.9.31, only outputs UPnP status Warning - blocking, very slow, queries the active UPnP router, will take many seconds if it has vanished.
  
  Overrides:
  
  renderStatusHTML in class CommSystemFacade
  
  Throws:
  
  IOException
- getTransports
  
  public SortedMap<String,Transport> getTransports()
  
  Overrides:
  
  getTransports in class CommSystemFacade
  
  Returns:
  
  SortedMap of style to Transport (a copy)
  
  Since:
  
  0.9.31
- createAddresses
  
  public List<RouterAddress> createAddresses()
  
  Description copied from class: CommSystemFacade
  
  Create the list of RouterAddress structures based on the router's config
  
  Overrides:
  
  createAddresses in class CommSystemFacade
  
  Returns:
  
  non-null, possibly empty
- notifyReplaceAddress
  
  public void notifyReplaceAddress(RouterAddress udpAddr)
  
  UDP changed addresses, tell NTCP and restart All the work moved to NTCPTransport.externalAddressReceived()
  
  Overrides:
  
  notifyReplaceAddress in class CommSystemFacade
  
  Parameters:
  
  udpAddr - may be null; or udpAddr's host/IP may be null
- notifyRemoveAddress
  
  public void notifyRemoveAddress(RouterAddress address)
  
  Tell other transports our address changed
  
  Overrides:
  
  notifyRemoveAddress in class CommSystemFacade
  
  Parameters:
  
  address - may be null; or address's host/IP may be null
  
  Since:
  
  0.9.20
- notifyRemoveAddress
  
  public void notifyRemoveAddress(boolean ipv6)
  
  Tell other transports our address changed
  
  Overrides:
  
  notifyRemoveAddress in class CommSystemFacade
  
  Since:
  
  0.9.20
- registerTransport
  
  public void registerTransport(Transport t)
  
  Pluggable transports. Not for NTCP or SSU. Do not call from transport constructor. Transport must be ready to be started. Following transport methods will be called: setListener() externalAddressReceived() (zero or more times, one for each known address) startListening();
  
  Overrides:
  
  registerTransport in class CommSystemFacade
  
  Since:
  
  0.9.16
- unregisterTransport
  
  public void unregisterTransport(Transport t)
  
  Pluggable transports. Not for NTCP or SSU. Following transport methods will be called: setListener(null) stoptListening();
  
  Overrides:
  
  unregisterTransport in class CommSystemFacade
  
  Since:
  
  0.9.16
- getDHFactory
  
  public DHSessionKeyBuilder.Factory getDHFactory()
  
  Hook for pluggable transport creation.
  
  Overrides:
  
  getDHFactory in class CommSystemFacade
  
  Since:
  
  0.9.16
- getXDHFactory
  
  public X25519KeyFactory getXDHFactory()
  
  Factory for making X25519 key pairs.
  
  Overrides:
  
  getXDHFactory in class CommSystemFacade
  
  Since:
  
  0.9.46
- initGeoIP
  
  public void initGeoIP()
  
  Router must call after netdb is initialized
  
  Overrides:
  
  initGeoIP in class CommSystemFacade
  
  Since:
  
  0.9.41
- queueLookup
  
  public void queueLookup(byte[] ip)
  
  Overrides:
  
  queueLookup in class CommSystemFacade
  
  Parameters:
  
  ip - ipv4 or ipv6
- getOurCountry
  
  public String getOurCountry()
  
  Overrides:
  
  getOurCountry in class CommSystemFacade
  
  Returns:
  
  two-letter lower-case country code or null
  
  Since:
  
  0.8.11
- isInStrictCountry
  
  public boolean isInStrictCountry()
  
  Are we in a strict country
  
  Overrides:
  
  isInStrictCountry in class CommSystemFacade
  
  Since:
  
  0.8.13
- isInStrictCountry
  
  public boolean isInStrictCountry(Hash peer)
  
  Are they in a strict country. Not recommended for our local router hash, as we may not be either in the cache or netdb, or may not be publishing an IP.
  
  Overrides:
  
  isInStrictCountry in class CommSystemFacade
  
  Parameters:
  
  peer - non-null
  
  Since:
  
  0.9.16
- isInStrictCountry
  
  public boolean isInStrictCountry(RouterInfo ri)
  
  Are they in a strict country
  
  Overrides:
  
  isInStrictCountry in class CommSystemFacade
  
  Parameters:
  
  ri - non-null
  
  Since:
  
  0.9.16
- getCountry
  
  public String getCountry(Hash peer)
  
  Uses the transport IP first because that lookup is fast, then the IP from the netDb. Not recommended for our local router hash, as we may not be either in the cache or netdb, or may not be publishing an IP. As of 0.9.32, works only for literal IPs, returns null for host names.
  
  Overrides:
  
  getCountry in class CommSystemFacade
  
  Parameters:
  
  peer - not ourselves - use getOurCountry() for that
  
  Returns:
  
  two-letter lower-case country code or null
- getValidIP
  
  public static byte[] getValidIP(RouterInfo ri)
  
  Return first valid IP (v4 or v6) we find, any transport. Local and other invalid IPs will not be returned. As of 0.9.32, works only for literal IPs, returns null for host names.
  
  Returns:
  
  IP or null
  
  Since:
  
  0.9.18
- getCountryName
  
  public String getCountryName(String c)
  
  full name for a country code, or the code if we don't know the name
  
  Overrides:
  
  getCountryName in class CommSystemFacade
- renderPeerHTML
  
  public String renderPeerHTML(Hash peer)
  
  Provide a consistent "look" for displaying router IDs in the console
  
  Overrides:
  
  renderPeerHTML in class CommSystemFacade
- isDummy
  
  public boolean isDummy()
  
  Is everything disabled for testing?
  
  Overrides:
  
  isDummy in class CommSystemFacade
  
  Since:
  
  0.8.13

Class CommSystemFacadeImpl

Nested Class Summary

Nested classes/interfaces inherited from class net.i2p.router.CommSystemFacade

Field Summary

Fields inherited from class net.i2p.router.CommSystemFacade

Constructor Summary

Method Summary

Methods inherited from class net.i2p.router.CommSystemFacade

Methods inherited from class java.lang.Object

Constructor Details

Method Details