SearchJob (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

java.lang.Object
- net.i2p.router.JobImpl
- - net.i2p.router.networkdb.kademlia.SearchJob

All Implemented Interfaces:
Job
Direct Known Subclasses:
ExploreJob
```
public class SearchJob
extends JobImpl
```
Base class for iterative network database search operations.
Searches for a specific key by querying peers iteratively until either the value is found or all available peers are exhausted. Manages search state, timeout handling, and peer selection with configurable concurrency levels.
Note that this is rarely used directly and primarily serves as a base for ExploreJob. FloodOnlySearchJob and FloodSearchJob do not extend this class. Does not update peer profile statistics.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`SearchJob.FailedJob` Called when a particular peer failed to respond before the timeout was reached, or if the peer could not be contacted at all.

Field Summary

Fields
Modifier and Type	Field and Description
`protected KademliaNetworkDatabaseFacade`	`_facade` Network database facade for peer lookups and storage.
`protected Log`	`_log` Class logger.
`(package private) static int`	`MAX_CLOSEST` Only send the 10 closest "don't tell me about" refs
`(package private) static long`	`MIN_TIMEOUT` Minimum timeout in ms
`(package private) static int`	`PER_FLOODFILL_PEER_TIMEOUT` Timeout per floodfill peer in ms

Fields inherited from class net.i2p.router.JobImpl
_id

Constructor Summary

Constructors
Constructor and Description
`SearchJob(RouterContext context, KademliaNetworkDatabaseFacade facade, Hash key, Job onSuccess, Job onFailure, long timeoutMs, boolean keepStats, boolean isLease, long msgIDBloomXor)` Create a new search for the routingKey specified

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) boolean`	`add(Hash peer)` Adds a peer to the search.
`int`	`addDeferred(Job onFind, Job onFail, long expiration, boolean isLease)` Add a deferred search to run on completion of this search.
`protected I2NPMessage`	`buildMessage(TunnelId replyTunnelId, Hash replyGateway, long expiration, RouterInfo peer)` Build the database search message
`protected void`	`continueSearch()` Send a series of searches to the next available peers as selected by the routing table, but making sure no more than SEARCH_BREDTH are outstanding at any time
`(package private) void`	`decrementOutstandingFloodfillSearches()` Decrement the count of outstanding floodfill searches
`protected void`	`fail()` Search totally failed
`protected int`	`getBredth()` Max # of concurrent searches
`long`	`getExpiration()` Absolute time when this search expires.
`protected KademliaNetworkDatabaseFacade`	`getFacade()` The network database facade.
`static int`	`getLeaseResendCount()` The current max peers that get a lease republish after a search.
`String`	`getName()` Descriptive name of the task
`protected int`	`getPerPeerTimeoutMs()` Let each peer take up to the average successful search RTT
`protected int`	`getPerPeerTimeoutMs(Hash peer)` Per-peer timeout adjusted for floodfill and remaining time.
`static long`	`getResendTimeout()` The current lease republish message window.
`protected SearchState`	`getState()` Search state tracking attempted/pending/failed peers.
`long`	`getTimeoutMs()` Timeout duration in milliseconds.
`protected void`	`newPeersFound(int numNewPeers)` We've gotten a search reply that contained the specified number of peers that we didn't know about before.
`(package private) static boolean`	`onlyQueryFloodfillPeers(RouterContext ctx)` This is now misnamed, as it is only used to determine whether to return floodfill peers only
`(package private) void`	`replyFound(DatabaseSearchReplyMessage message, Hash peer)` Found a reply
`void`	`runJob()` Execute the next step of the iterative search.
`protected void`	`searchNext()` Send the next search, or stop if its completed
`protected void`	`sendLeaseSearch(RouterInfo router)` We're (probably) searching for a LeaseSet, so to be (overly) cautious, we're sending the request out through a tunnel w/ reply back through another tunnel.
`protected void`	`sendRouterSearch(RouterInfo router)` We're searching for a router, so we can just send direct
`protected void`	`sendSearch(RouterInfo router)` Send a search to the given peer
`static void`	`setLeaseResendCount(int val)` Max peers that get a lease republish after a search.
`static void`	`setResendTimeout(int val)` Lease republish message window.
`(package private) long`	`timeoutMs()` The search timeout in ms.
`String`	`toString()`
`(package private) boolean`	`wasAttempted(Hash peer)` Whether the peer was already queried.

Methods inherited from class net.i2p.router.JobImpl
dropped, getContext, getJobId, getMadeReadyOn, getTiming, madeReady, requeue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - _facade
```
protected final KademliaNetworkDatabaseFacade _facade
```
    Network database facade for peer lookups and storage.
  - _log
```
protected final Log _log
```
    Class logger.
  - MAX_CLOSEST
```
static final int MAX_CLOSEST
```
    Only send the 10 closest "don't tell me about" refs
    See Also:
    Constant Field Values
  - MIN_TIMEOUT
```
static final long MIN_TIMEOUT
```
    Minimum timeout in ms
    See Also:
    Constant Field Values
  - PER_FLOODFILL_PEER_TIMEOUT
```
static final int PER_FLOODFILL_PEER_TIMEOUT
```
    Timeout per floodfill peer in ms
    See Also:
    Constant Field Values
- Constructor Detail
  - SearchJob
```
public SearchJob(RouterContext context,
                 KademliaNetworkDatabaseFacade facade,
                 Hash key,
                 Job onSuccess,
                 Job onFailure,
                 long timeoutMs,
                 boolean keepStats,
                 boolean isLease,
                 long msgIDBloomXor)
```
    Create a new search for the routingKey specified
- Method Detail
  - add
```
boolean add(Hash peer)
```
    Adds a peer to the search.
    Returns:
    true if peer was new
  - addDeferred
```
public int addDeferred(Job onFind,
                       Job onFail,
                       long expiration,
                       boolean isLease)
```
    Add a deferred search to run on completion of this search.
  - buildMessage
```
protected I2NPMessage buildMessage(TunnelId replyTunnelId,
                                   Hash replyGateway,
                                   long expiration,
                                   RouterInfo peer)
```
    Build the database search message
    Parameters:
    replyTunnelId - tunnel to receive replies through
    replyGateway - gateway for the reply tunnel
    expiration - when the search should stop
    peer - unused here; see ExploreJob extension
    Returns:
    a DatabaseLookupMessage
  - continueSearch
```
protected void continueSearch()
```
    Send a series of searches to the next available peers as selected by the routing table, but making sure no more than SEARCH_BREDTH are outstanding at any time
  - decrementOutstandingFloodfillSearches
```
void decrementOutstandingFloodfillSearches()
```
    Decrement the count of outstanding floodfill searches
  - fail
```
protected void fail()
```
    Search totally failed
  - getBredth
```
protected int getBredth()
```
    Max # of concurrent searches
  - getExpiration
```
public long getExpiration()
```
    Absolute time when this search expires.
    Returns:
    absolute time when this search expires
  - getFacade
```
protected KademliaNetworkDatabaseFacade getFacade()
```
    The network database facade.
    Returns:
    the network database facade
  - getLeaseResendCount
```
public static int getLeaseResendCount()
```
    The current max peers that get a lease republish after a search.
    Returns:
    the max peers
  - getName
```
public String getName()
```
    Description copied from interface: Job
    Descriptive name of the task
    Returns:
    the descriptive name of the task
  - getPerPeerTimeoutMs
```
protected int getPerPeerTimeoutMs()
```
    Let each peer take up to the average successful search RTT
    Returns:
    the per peer timeout ms
  - getPerPeerTimeoutMs
```
protected int getPerPeerTimeoutMs(Hash peer)
```
    Per-peer timeout adjusted for floodfill and remaining time.
  - getResendTimeout
```
public static long getResendTimeout()
```
    The current lease republish message window.
    Returns:
    the window in ms
  - getState
```
protected SearchState getState()
```
    Search state tracking attempted/pending/failed peers.
    Returns:
    search state tracking attempted/pending/failed peers
  - getTimeoutMs
```
public long getTimeoutMs()
```
    Timeout duration in milliseconds.
    Returns:
    timeout duration in milliseconds
  - newPeersFound
```
protected void newPeersFound(int numNewPeers)
```
    We've gotten a search reply that contained the specified number of peers that we didn't know about before.
  - onlyQueryFloodfillPeers
```
static boolean onlyQueryFloodfillPeers(RouterContext ctx)
```
    This is now misnamed, as it is only used to determine whether to return floodfill peers only
  - replyFound
```
void replyFound(DatabaseSearchReplyMessage message,
                Hash peer)
```
    Found a reply
  - runJob
```
public void runJob()
```
    Execute the next step of the iterative search.
  - searchNext
```
protected void searchNext()
```
    Send the next search, or stop if its completed
  - sendLeaseSearch
```
protected void sendLeaseSearch(RouterInfo router)
```
    We're (probably) searching for a LeaseSet, so to be (overly) cautious, we're sending the request out through a tunnel w/ reply back through another tunnel.
  - sendRouterSearch
```
protected void sendRouterSearch(RouterInfo router)
```
    We're searching for a router, so we can just send direct
  - sendSearch
```
protected void sendSearch(RouterInfo router)
```
    Send a search to the given peer
  - setLeaseResendCount
```
public static void setLeaseResendCount(int val)
```
    Max peers that get a lease republish after a search. Tuner may call this.
    Parameters:
    val - clamped to [5, 10]
  - setResendTimeout
```
public static void setResendTimeout(int val)
```
    Lease republish message window. Tuner may call this.
    Parameters:
    val - ms, clamped to [10s, 30s]
  - timeoutMs
```
long timeoutMs()
```
    The search timeout in ms.
    Returns:
    the search timeout in ms
  - toString
```
public String toString()
```
    Overrides:
    toString in class JobImpl
  - wasAttempted
```
boolean wasAttempted(Hash peer)
```
    Whether the peer was already queried.
    Returns:
    true if peer was already queried

Class SearchJob

Nested Class Summary

Field Summary

Fields inherited from class net.i2p.router.JobImpl

Constructor Summary

Method Summary

Methods inherited from class net.i2p.router.JobImpl

Methods inherited from class java.lang.Object

Field Detail

_facade

_log

MAX_CLOSEST

MIN_TIMEOUT

PER_FLOODFILL_PEER_TIMEOUT

Constructor Detail

SearchJob

Method Detail

add

addDeferred

buildMessage

continueSearch

decrementOutstandingFloodfillSearches

fail

getBredth

getExpiration

getFacade

getLeaseResendCount

getName

getPerPeerTimeoutMs

getPerPeerTimeoutMs

getResendTimeout

getState

getTimeoutMs

newPeersFound

onlyQueryFloodfillPeers

replyFound

runJob

searchNext

sendLeaseSearch

sendRouterSearch

sendSearch

setLeaseResendCount

setResendTimeout

timeoutMs

toString

wasAttempted