SearchState (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.networkdb.kademlia.SearchState

```
class SearchState
extends Object
```
Manages state for network database search operations.
Tracks peer interaction status, timing information, and search progress for iterative Kademlia searches. Maintains separate sets for pending, attempted, failed, successful, and replied peers to coordinate concurrent search operations and prevent duplicate queries.
Thread-safe implementation using synchronized collections and atomic counters for safe concurrent access from multiple search jobs.

Constructor Summary
Constructors
Constructor and Description
SearchState(RouterContext context, Hash key)
SearchState.

Constructors
Constructor and Description
`SearchState(RouterContext context, Hash key)` SearchState.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`abort()` Aborts this search state.
`void`	`addInitialLeaseSetResponse(Hash peer, LeaseSet ls)` Record the peer's LeaseSet response from the initial phase.
`void`	`addLeaseSetResponse(Hash peer, LeaseSet ls)` Record the peer's LeaseSet response.
`void`	`addPending(Collection<Hash> pending)` Add the peers to the pending and attempted sets.
`void`	`addPending(Hash peer)` Add the peer to the pending and attempted sets.
`void`	`clearInitialTracking()` Clear the initial response tracking state.
`void`	`complete()` Mark the search as completed at the current time.
`boolean`	`completed()` Whether the search has completed.
`long`	`dataFound(Hash peer)` How long it took to get the reply, or -1 if we don't know.
`Set<Hash>`	`getAttempted()` Copy of the attempted peers.
`int`	`getAttemptedSize()` Number of attempted peers.
`LeaseSet`	`getBestInitialLeaseSet()` LeaseSet with the newest lease date among the initial responses.
`Set<Hash>`	`getClosestAttempted(int max)` Up to max attempted peers closest to the target.
`Set<Hash>`	`getFailed()` Copy of the failed peers.
`int`	`getFailedSize()` Number of failed peers.
`LeaseSet`	`getNewestLeaseSet()` LeaseSet with the newest lease date among the responses.
`Set<Hash>`	`getPending()` Copy of the pending peers.
`int`	`getPendingSize()` Number of pending peers.
`Set<Hash>`	`getRepliedPeers()` Copy of the peers that replied.
`long`	`getStoredLeaseDate()` Stored lease date of the last accepted LeaseSet.
`Set<Hash>`	`getSuccessful()` Copy of the successful peers.
`int`	`getSuccessfulSize()` Number of successful peers.
`Hash`	`getTarget()` The search target.
`long`	`getWhenCompleted()` Time the search completed, or -1 if not yet completed.
`long`	`getWhenStarted()` Time the search started.
`boolean`	`isAborted()` Checks if this search state has been aborted.
`void`	`removePending(Hash peer)` We didn't actually want to add this peer as part of the pending list...
`long`	`replyFound(Hash peer)` How long it took to get the reply, or -1 if we don't know.
`void`	`replyTimeout(Hash peer)` Move the peer from pending to failed on timeout.
`void`	`setStoredLeaseDate(long date)` Record the stored lease date.
`boolean`	`shouldStoreInitial()` Whether enough initial responses have been received to store.
`boolean`	`shouldUpdateStored(LeaseSet ls)` Whether the given LeaseSet is newer than the stored one.
`String`	`toString()` Debug string for this search state.
`boolean`	`wasAttempted(Hash peer)` Whether the peer was attempted.

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

- Constructor Detail
  - SearchState
```
public SearchState(RouterContext context,
                   Hash key)
```
    SearchState.
- Method Detail
  - abort
```
public void abort()
```
    Aborts this search state.
  - addInitialLeaseSetResponse
```
public void addInitialLeaseSetResponse(Hash peer,
                                       LeaseSet ls)
```
    Record the peer's LeaseSet response from the initial phase.
    Parameters:
    peer - the peer that responded
    ls - the received LeaseSet
  - addLeaseSetResponse
```
public void addLeaseSetResponse(Hash peer,
                                LeaseSet ls)
```
    Record the peer's LeaseSet response.
    Parameters:
    peer - the peer that responded
    ls - the received LeaseSet
  - addPending
```
public void addPending(Collection<Hash> pending)
```
    Add the peers to the pending and attempted sets.
    Parameters:
    pending - the peers to add
  - addPending
```
public void addPending(Hash peer)
```
    Add the peer to the pending and attempted sets.
    Parameters:
    peer - the peer to add
  - clearInitialTracking
```
public void clearInitialTracking()
```
    Clear the initial response tracking state.
  - complete
```
public void complete()
```
    Mark the search as completed at the current time.
  - completed
```
public boolean completed()
```
    Whether the search has completed.
  - dataFound
```
public long dataFound(Hash peer)
```
    How long it took to get the reply, or -1 if we don't know.
  - getAttempted
```
public Set<Hash> getAttempted()
```
    Copy of the attempted peers.
    Returns:
    the attempted
  - getAttemptedSize
```
public int getAttemptedSize()
```
    Number of attempted peers.
    Returns:
    the attempted size
  - getBestInitialLeaseSet
```
public LeaseSet getBestInitialLeaseSet()
```
    LeaseSet with the newest lease date among the initial responses.
    Returns:
    the best initial lease set
  - getClosestAttempted
```
public Set<Hash> getClosestAttempted(int max)
```
    Up to max attempted peers closest to the target.
    Returns:
    the closest attempted
  - getFailed
```
public Set<Hash> getFailed()
```
    Copy of the failed peers.
    Returns:
    the failed
  - getFailedSize
```
public int getFailedSize()
```
    Number of failed peers.
    Returns:
    the failed size
  - getNewestLeaseSet
```
public LeaseSet getNewestLeaseSet()
```
    LeaseSet with the newest lease date among the responses.
    Returns:
    the newest lease set
  - getPending
```
public Set<Hash> getPending()
```
    Copy of the pending peers.
    Returns:
    the pending
  - getPendingSize
```
public int getPendingSize()
```
    Number of pending peers.
    Returns:
    the pending size
  - getRepliedPeers
```
public Set<Hash> getRepliedPeers()
```
    Copy of the peers that replied.
    Returns:
    the replied peers
  - getStoredLeaseDate
```
public long getStoredLeaseDate()
```
    Stored lease date of the last accepted LeaseSet.
    Returns:
    the stored lease date
  - getSuccessful
```
public Set<Hash> getSuccessful()
```
    Copy of the successful peers.
    Returns:
    the successful
  - getSuccessfulSize
```
public int getSuccessfulSize()
```
    Number of successful peers.
    Returns:
    the successful size
  - getTarget
```
public Hash getTarget()
```
    The search target.
    Returns:
    the target
  - getWhenCompleted
```
public long getWhenCompleted()
```
    Time the search completed, or -1 if not yet completed.
    Returns:
    the when completed
  - getWhenStarted
```
public long getWhenStarted()
```
    Time the search started.
    Returns:
    the when started
  - isAborted
```
public boolean isAborted()
```
    Checks if this search state has been aborted.
    Returns:
    whether aborted
  - removePending
```
public void removePending(Hash peer)
```
    We didn't actually want to add this peer as part of the pending list...
  - replyFound
```
public long replyFound(Hash peer)
```
    How long it took to get the reply, or -1 if we don't know.
  - replyTimeout
```
public void replyTimeout(Hash peer)
```
    Move the peer from pending to failed on timeout.
    Parameters:
    peer - the peer that timed out
  - setStoredLeaseDate
```
public void setStoredLeaseDate(long date)
```
    Record the stored lease date.
    Parameters:
    date - the new stored lease date
  - shouldStoreInitial
```
public boolean shouldStoreInitial()
```
    Whether enough initial responses have been received to store.
    Returns:
    whether store initial
  - shouldUpdateStored
```
public boolean shouldUpdateStored(LeaseSet ls)
```
    Whether the given LeaseSet is newer than the stored one.
    Parameters:
    ls - the LeaseSet to compare
    Returns:
    whether update stored
  - toString
```
public String toString()
```
    Debug string for this search state.
    Overrides:
    toString in class Object
  - wasAttempted
```
public boolean wasAttempted(Hash peer)
```
    Whether the peer was attempted.

Class SearchState

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchState

Method Detail

abort

addInitialLeaseSetResponse

addLeaseSetResponse

addPending

addPending

clearInitialTracking

complete

completed

dataFound

getAttempted

getAttemptedSize

getBestInitialLeaseSet

getClosestAttempted

getFailed

getFailedSize

getNewestLeaseSet

getPending

getPendingSize

getRepliedPeers

getStoredLeaseDate

getSuccessful

getSuccessfulSize

getTarget

getWhenCompleted

getWhenStarted

isAborted

removePending

replyFound

replyTimeout

setStoredLeaseDate

shouldStoreInitial

shouldUpdateStored

toString

wasAttempted