net.i2p.router.networkdb.kademlia

Class IterativeSearchJob

java.lang.Object

net.i2p.router.JobImpl

net.i2p.router.networkdb.kademlia.FloodSearchJob

net.i2p.router.networkdb.kademlia.IterativeSearchJob

All Implemented Interfaces:

Job

public class IterativeSearchJob
extends FloodSearchJob

A traditional Kademlia search that continues to search when the initial lookup fails, by iteratively searching the closer-to-the-key peers returned by the query in a DSRM. Unlike traditional Kad, it doesn't stop when there are no closer keys, it keeps going until the timeout or max number of searches is reached. Differences from FloodOnlySearchJob: Chases peers in DSRM's immediately. FOSJ searches the two closest in parallel and then stops. There is no per-search timeout, only a total timeout. Here, we search one at a time, and must have a separate per-search timeout. Advantages: Much more robust than FOSJ, especially in a large network where not all floodfills are known. Longer total timeout. Halves search traffic for successful searches, as this doesn't do two sesarches in parallel like FOSJ does. Public only for JobQueue, not a public API, not for external use.

Since:

0.8.9

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENCRYPT_RI only on fast boxes, for now
static String	PROP_ENCRYPT_RI

Fields inherited from class net.i2p.router.networkdb.kademlia.FloodSearchJob

_created, _dead, _expiration, _facade, _isLease, _key, _log, _lookupsRemaining, _onFailed, _onFind, _success, _timeoutMs, CONCURRENT_SEARCHES

Constructor Summary

Constructors

Constructor and Description
IterativeSearchJob(RouterContext ctx, FloodfillNetworkDatabaseFacade facade, net.i2p.data.Hash key, Job onFind, Job onFailed, int timeoutMs, boolean isLease) Lookup using exploratory tunnels
IterativeSearchJob(RouterContext ctx, FloodfillNetworkDatabaseFacade facade, net.i2p.data.Hash key, Job onFind, Job onFailed, int timeoutMs, boolean isLease, net.i2p.data.Hash fromLocalDest) Lookup using the client's tunnels.

Method Summary

Modifier and Type	Method and Description
void	dropped() Dropped by the job queue
(package private) void	failed() Total failure
(package private) void	failed(net.i2p.data.Hash peer, boolean timedOut) Note that the peer did not respond with a DSM (either a DSRM, timeout, or failure).
net.i2p.data.Hash	getFromHash() Hash of the dest this query is from
String	getName() Deprecated, unused, see FOSJ override
(package private) void	newPeerToTry(net.i2p.data.Hash peer) A new (floodfill) peer was discovered that may have the answer.
void	runJob() Deprecated, unused, see FOSJ override
(package private) void	success() Deprecated, unused, see FOSJ override
(package private) long	timeSent(net.i2p.data.Hash peer) When did we send the query to the peer?
boolean	wasQueried(net.i2p.data.Hash peer) Did we send a request to this peer?

Methods inherited from class net.i2p.router.networkdb.kademlia.FloodSearchJob

addDeferred, decrementRemaining, getCreated, getExpiration, getKey, getLookupsRemaining

Methods inherited from class net.i2p.router.JobImpl

getAddedBy, getContext, getJobId, getMadeReadyOn, getTiming, madeReady, requeue, toString

Methods inherited from class java.lang.Object

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

Field Detail

PROP_ENCRYPT_RI

public static final String PROP_ENCRYPT_RI

See Also:

Constant Field Values

DEFAULT_ENCRYPT_RI

public static final boolean DEFAULT_ENCRYPT_RI

only on fast boxes, for now

Constructor Detail

IterativeSearchJob

public IterativeSearchJob(RouterContext ctx,
                          FloodfillNetworkDatabaseFacade facade,
                          net.i2p.data.Hash key,
                          Job onFind,
                          Job onFailed,
                          int timeoutMs,
                          boolean isLease)

Lookup using exploratory tunnels

IterativeSearchJob

public IterativeSearchJob(RouterContext ctx,
                          FloodfillNetworkDatabaseFacade facade,
                          net.i2p.data.Hash key,
                          Job onFind,
                          Job onFailed,
                          int timeoutMs,
                          boolean isLease,
                          net.i2p.data.Hash fromLocalDest)

Lookup using the client's tunnels. Do not use for RI lookups down client tunnels, as the response will be dropped in InboundMessageDistributor.

Parameters:

fromLocalDest - use these tunnels for the lookup, or null for exploratory

Since:

0.9.10

Method Detail

runJob

public void runJob()

Description copied from class: FloodSearchJob

Deprecated, unused, see FOSJ override

Specified by:

runJob in interface Job

Overrides:

runJob in class FloodSearchJob

getName

public String getName()

Description copied from class: FloodSearchJob

Deprecated, unused, see FOSJ override

Specified by:

getName in interface Job

Overrides:

getName in class FloodSearchJob

failed

void failed(net.i2p.data.Hash peer,
            boolean timedOut)

Note that the peer did not respond with a DSM (either a DSRM, timeout, or failure). This is not necessarily a total failure of the search.

Parameters:

timedOut - if true, will blame the peer's profile

newPeerToTry

void newPeerToTry(net.i2p.data.Hash peer)

A new (floodfill) peer was discovered that may have the answer.

Parameters:

peer - may not actually be new

getFromHash

public net.i2p.data.Hash getFromHash()

Hash of the dest this query is from

Returns:

null for router

Since:

0.9.13

wasQueried

public boolean wasQueried(net.i2p.data.Hash peer)

Did we send a request to this peer?

Since:

0.9.13

timeSent

long timeSent(net.i2p.data.Hash peer)

When did we send the query to the peer?

Returns:

context time, or -1 if never sent

dropped

public void dropped()

Dropped by the job queue

Specified by:

dropped in interface Job

Overrides:

dropped in class JobImpl

Since:

0.9.31

failed

void failed()

Total failure

Overrides:

failed in class FloodSearchJob

success

void success()

Description copied from class: FloodSearchJob

Deprecated, unused, see FOSJ override

Overrides:

success in class FloodSearchJob