org.bitcoinj.net.discovery

Class TorDiscovery

java.lang.Object

org.bitcoinj.net.discovery.TorDiscovery

All Implemented Interfaces:

PeerDiscovery

public class TorDiscovery
extends Object
implements PeerDiscovery

Supports peer discovery through Tor.

Failure to obtain at least four different peers through different exit nodes will cause a PeerDiscoveryException will be thrown during getPeers().

DNS seeds do not attempt to enumerate every peer on the network. If you want more peers to connect to, you need to discover them via other means (like addr broadcasts).

Field Summary

Fields

Modifier and Type	Field and Description
static int	MINIMUM_ROUTER_COUNT
static int	MINIMUM_ROUTER_LOOKUP_COUNT
static int	RECEIVE_RETRIES
static int	RESOLVE_CNAME
static int	RESOLVE_ERROR
static int	RESOLVE_IPV4
static int	RESOLVE_IPV6
static int	RESOLVE_STREAM_ID
static int	ROUTER_LOOKUP_COUNT

Constructor Summary

Constructors

Constructor and Description
TorDiscovery(NetworkParameters netParams, com.subgraph.orchid.TorClient torClient) Supports finding peers through Tor.
TorDiscovery(String[] hostNames, NetworkParameters netParams, com.subgraph.orchid.TorClient torClient) Supports finding peers through Tor.

Method Summary

Modifier and Type	Method and Description
InetSocketAddress[]	getPeers(long services, long timeoutValue, TimeUnit timeoutUnit) Returns an array of addresses.
void	shutdown() Stops any discovery in progress when we want to shut down quickly.

Methods inherited from class java.lang.Object

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

Field Detail

MINIMUM_ROUTER_COUNT

public static final int MINIMUM_ROUTER_COUNT

See Also:

Constant Field Values

ROUTER_LOOKUP_COUNT

public static final int ROUTER_LOOKUP_COUNT

See Also:

Constant Field Values

MINIMUM_ROUTER_LOOKUP_COUNT

public static final int MINIMUM_ROUTER_LOOKUP_COUNT

See Also:

Constant Field Values

RECEIVE_RETRIES

public static final int RECEIVE_RETRIES

See Also:

Constant Field Values

RESOLVE_STREAM_ID

public static final int RESOLVE_STREAM_ID

See Also:

Constant Field Values

RESOLVE_CNAME

public static final int RESOLVE_CNAME

See Also:

Constant Field Values

RESOLVE_ERROR

public static final int RESOLVE_ERROR

See Also:

Constant Field Values

RESOLVE_IPV4

public static final int RESOLVE_IPV4

See Also:

Constant Field Values

RESOLVE_IPV6

public static final int RESOLVE_IPV6

See Also:

Constant Field Values

Constructor Detail

TorDiscovery

public TorDiscovery(NetworkParameters netParams,
                    com.subgraph.orchid.TorClient torClient)

Supports finding peers through Tor. Community run DNS entry points will be used.

Parameters:

netParams - Network parameters to be used for port information.

TorDiscovery

public TorDiscovery(String[] hostNames,
                    NetworkParameters netParams,
                    com.subgraph.orchid.TorClient torClient)

Supports finding peers through Tor.

Parameters:

hostNames - Host names to be examined for seed addresses.

netParams - Network parameters to be used for port information.

torClient - an already-started Tor client.

Method Detail

getPeers

public InetSocketAddress[] getPeers(long services,
                                    long timeoutValue,
                                    TimeUnit timeoutUnit)
                             throws PeerDiscoveryException

Description copied from interface: PeerDiscovery

Returns an array of addresses. This method may block.

Specified by:

getPeers in interface PeerDiscovery

Parameters:

services - Required services as a bitmask, e.g. VersionMessage#NODE_NETWORK.

Throws:

PeerDiscoveryException

shutdown

public void shutdown()

Description copied from interface: PeerDiscovery

Stops any discovery in progress when we want to shut down quickly.

Specified by:

shutdown in interface PeerDiscovery