FloodOnlySearchJob

net.i2p.router.networkdb.kademlia.FloodOnlySearchJob

All Implemented Interfaces:: Job

Direct Known Subclasses:: DirectLookupJob, SingleSearchJob

abstract class FloodOnlySearchJobextends FloodSearchJob

Flood-only search implementation for network database lookups.

Sends search queries to floodfill peers with no fallback to Kademlia search. Fails completely if no successful match is received from initial peers. Includes enhancements to help routers bootstrap back into the network after losing floodfill references by following floodfill keys in DatabaseSearchReplyMessages.

Field Summary
Fields
Modifier and Type
Field
Description
protected final ReplyJob
_onReply
Job to run on reply.
protected final Job
_onTimeout
Job to run on timeout.
private OutNetMessage
_out
This is a marker to register with the MessageRegistry, it is never sent.
protected final MessageSelector
_replySelector
Reply message selector.
private boolean
_shouldProcessDSRM
Whether a search reply should be processed.
private final HashSet<Hash>
_unheardFrom
Peers that did not answer this search.
Fields inherited from class FloodSearchJob
_created, _dead, _expiration, _facade, _isLease, _key, _log, _lookupsRemaining, _onFailed, _onFind, _success, _timeoutMs, CONCURRENT_SEARCHES
Modifier and Type
Field
Description
protected final long
_created
System time when this search was created.
protected boolean
_dead
Whether this search has been marked as completed.
protected long
_expiration
Deadline after which the search expires.
protected final FloodfillNetworkDatabaseFacade
_facade
Floodfill network database facade.
protected final boolean
_isLease
Whether the target is a LeaseSet lookup.
protected final Hash
_key
Target database entry hash being searched.
protected final Log
_log
Class logger.
protected final AtomicInteger
_lookupsRemaining
Remaining flood lookups before fallback to iterative search.
protected final List<Job>
_onFailed
Callbacks for search failure.
protected final List<Job>
_onFind
Callbacks for successful search completion.
protected boolean
_success
Whether the search completed successfully.
protected int
_timeoutMs
Timeout for the search in milliseconds.
protected static final int
CONCURRENT_SEARCHES
Max simultaneous flood lookups before fallback.
Fields inherited from class JobImpl
_id
Modifier and Type
Field
Description
final long
_id
Unique job identifier.
Constructor Summary
Constructors
Modifier
Constructor
Description
protected
FloodOnlySearchJob(RouterContext ctx, FloodfillNetworkDatabaseFacade facade, Hash key, Job onFind, Job onFailed, int timeoutMs)
For DirectLookupJob extension, RI only, different match job.
FloodOnlySearchJob(RouterContext ctx, FloodfillNetworkDatabaseFacade facade, Hash key, Job onFind, Job onFailed, int timeoutMs, boolean isLease)
Flood-only search for the given key against the floodfill network database.
Method Summary
Public Methods
Modifier and Type
Method
Description
(package private) int
decrementRemaining(Hash peer)
Note that we heard from the peer.
(package private) void
failed()
Deprecated, unused, see FOSJ override.
String
getName()
Deprecated, unused, see FOSJ override.
void
runJob()
Deprecated, unused, see FOSJ override.
boolean
shouldProcessDSRM()
Whether a DSRM reply should be processed.
(package private) void
success()
Deprecated, unused, see FOSJ override.
Methods inherited from class FloodSearchJob
addDeferred, decrementRemaining, getCreated, getExpiration, getKey, getLookupsRemaining
Modifier and Type
Method
Description
(package private) void
addDeferred(Job onFind, Job onFailed, long timeoutMs, boolean isLease)
Add jobs to an existing search.
protected int
decrementRemaining()
Number of lookups remaining after decrementing.
long
getCreated()
System time, NOT context time.
long
getExpiration()
Expiration time from the context clock.
Hash
getKey()
The database entry hash being searched.
protected int
getLookupsRemaining()
Number of flood lookups still pending.
Methods inherited from class JobImpl
dropped, getContext, getJobId, getMadeReadyOn, getTiming, madeReady, requeue, toString
Modifier and Type
Method
Description
void
dropped()
Default implementation does nothing.
final RouterContext
getContext()
The router context that this job belongs to.
long
getJobId()
The unique job ID for this job.
long
getMadeReadyOn()
The timestamp when this job was last made ready for execution.
JobTiming
getTiming()
The timing object for this job.
void
madeReady(long now)
For JobQueue only, not for external use.
protected void
requeue(long delayMs)
Requeue this job to run after the specified delay.
String
toString()

Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- _shouldProcessDSRM
  private boolean _shouldProcessDSRM
  Whether a search reply should be processed.
- _unheardFrom
  private final HashSet<Hash> _unheardFrom
  Peers that did not answer this search.
- _out
  private OutNetMessage _out
  This is a marker to register with the MessageRegistry, it is never sent.
- _replySelector
  protected final MessageSelector _replySelector
  Reply message selector.
- _onReply
  protected final ReplyJob _onReply
  Job to run on reply.
- _onTimeout
  protected final Job _onTimeout
  Job to run on timeout.
Constructor Details
- FloodOnlySearchJob
  public FloodOnlySearchJob(RouterContext ctx, FloodfillNetworkDatabaseFacade facade, Hash key, Job onFind, Job onFailed, int timeoutMs, boolean isLease)
  Flood-only search for the given key against the floodfill network database.
  Parameters:
  ctx - the router context
  facade - the floodfill network database facade
  key - the hash key to search for
  onFind - job to run on successful find
  onFailed - job to run on failure
  timeoutMs - the timeout in milliseconds
  isLease - true if searching for a lease set
- FloodOnlySearchJob
  protected FloodOnlySearchJob(RouterContext ctx, FloodfillNetworkDatabaseFacade facade, Hash key, Job onFind, Job onFailed, int timeoutMs)
  For DirectLookupJob extension, RI only, different match job.
  Parameters:
  ctx - the router context
  facade - the floodfill network database facade
  key - the hash key to search for
  onFind - job to run on successful find
  onFailed - job to run on failure
  timeoutMs - the timeout in milliseconds
Method Details
- shouldProcessDSRM
  public boolean shouldProcessDSRM()
  Whether a DSRM reply should be processed.
  Returns:
  true if DSRM should be processed
- 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
  Returns:
  the fixed descriptive name "NetDb Search (phase 1)" of this job
- decrementRemaining
  int decrementRemaining(Hash peer)
  Note that we heard from the peer.
  Parameters:
  peer - the peer hash
  Returns:
  number remaining after decrementing
- failed
  void failed()
  Description copied from class: FloodSearchJob
  Deprecated, unused, see FOSJ override.
  Overrides:
  failed in class FloodSearchJob
- success
  void success()
  Description copied from class: FloodSearchJob
  Deprecated, unused, see FOSJ override.
  Overrides:
  success in class FloodSearchJob

Field Summary

Fields inherited from class FloodSearchJob

Fields inherited from class JobImpl

Constructor Summary

Method Summary

Methods inherited from class FloodSearchJob

Methods inherited from class JobImpl

Methods inherited from class Object

Field Details

_shouldProcessDSRM

_unheardFrom

_out

_replySelector

_onReply

_onTimeout

Constructor Details

FloodOnlySearchJob

Method Details

shouldProcessDSRM

runJob

getName

decrementRemaining

failed

success