org.apache.solr.search

Class SolrQueryTimeoutImpl

java.lang.Object

org.apache.solr.search.SolrQueryTimeoutImpl

All Implemented Interfaces:

QueryTimeout

public class SolrQueryTimeoutImpl
extends Object
implements QueryTimeout

Implementation of QueryTimeout that is used by Solr. It uses a ThreadLocal variable to track the timeoutAt value for each request thread.

Method Summary

Modifier and Type	Method and Description
static Long	get() The time (nanoseconds) at which the request should be considered timed out.
static SolrQueryTimeoutImpl	getInstance() Return singleton instance
boolean	isTimeoutEnabled()
static void	reset() Cleanup the ThreadLocal timeout value.
static void	set(Long timeAllowed) Sets the time allowed (milliseconds), assuming we start a timer immediately.
static void	set(SolrQueryRequest req) Sets or clears the time allowed based on how much time remains from the start of the request plus the configured CommonParams.TIME_ALLOWED.
boolean	shouldExit() Return true if a timeoutAt value is set and the current time has exceeded the set timeOut.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static SolrQueryTimeoutImpl getInstance()

Return singleton instance

get

public static Long get()

The time (nanoseconds) at which the request should be considered timed out.

isTimeoutEnabled

public boolean isTimeoutEnabled()

Specified by:

isTimeoutEnabled in interface QueryTimeout

shouldExit

public boolean shouldExit()

Return true if a timeoutAt value is set and the current time has exceeded the set timeOut.

Specified by:

shouldExit in interface QueryTimeout

set

public static void set(SolrQueryRequest req)

Sets or clears the time allowed based on how much time remains from the start of the request plus the configured CommonParams.TIME_ALLOWED.

set

public static void set(Long timeAllowed)

Sets the time allowed (milliseconds), assuming we start a timer immediately. You should probably invoke set(SolrQueryRequest) instead.

reset

public static void reset()

Cleanup the ThreadLocal timeout value.

toString

public String toString()

Overrides:

toString in class Object