com.yahoo.search.federation

Class FederationResult

java.lang.Object

com.yahoo.search.federation.FederationResult

class FederationResult
extends Object

The result of a federation to targets which knows how to wait for the result from each target. This thread handles multiple threads producing target results but only a single thread may use an instance of this.

Author:

bratseth

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FederationResult.Builder
(package private) static class	FederationResult.TargetResult

Field Summary

Fields

Modifier and Type	Field and Description
private List<FederationResult.TargetResult>	targetResults All targets of this
private List<FederationResult.TargetResult>	targetsToWaitFor The remaining targets to wait for.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	FederationResult(com.google.common.collect.ImmutableList<FederationResult.TargetResult> targetResults)

Method Summary

Modifier and Type	Method and Description
List<FederationResult.TargetResult>	all() Returns an immutable list of the results of this
private FederationResult.TargetResult	targetWithSmallestTimeout(List<FederationResult.TargetResult> results, int queryTimeout)
void	waitForAll(int queryTimeout, Clock clock) Wait on each target for that targets timeout On the worst case this is the same as waiting for the max target timeout, in the average case it may be much better because lower timeout sources do not get to drive the timeout above their own timeout value.

Methods inherited from class java.lang.Object

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

Field Detail

targetResults

private final List<FederationResult.TargetResult> targetResults

All targets of this

targetsToWaitFor

private List<FederationResult.TargetResult> targetsToWaitFor

The remaining targets to wait for. Other targets are either complete, or should only be included if they are available when we complete

Constructor Detail

FederationResult

private FederationResult(com.google.common.collect.ImmutableList<FederationResult.TargetResult> targetResults)

Method Detail

waitForAll

public void waitForAll(int queryTimeout,
                       Clock clock)

Wait on each target for that targets timeout On the worst case this is the same as waiting for the max target timeout, in the average case it may be much better because lower timeout sources do not get to drive the timeout above their own timeout value. When this completes, results can be accessed from the TargetResults with no blocking (i.e getOrTimeout) without breaking any contract.

all

public List<FederationResult.TargetResult> all()

Returns an immutable list of the results of this

targetWithSmallestTimeout

private FederationResult.TargetResult targetWithSmallestTimeout(List<FederationResult.TargetResult> results,
                                                                int queryTimeout)