Package org.hibernate.search.engine.search.timeout.spi

Class TimeoutManager

java.lang.Object

org.hibernate.search.engine.search.timeout.spi.TimeoutManager

public class TimeoutManager
extends Object

Author:

Emmanuel Bernard

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimeoutManager.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected Long	timeoutMs
protected TimingSource	timingSource
protected TimeoutManager.Type	type

Constructor Summary

Constructors

Constructor	Description
TimeoutManager(TimingSource timingSource, Long timeoutMs, TimeoutManager.Type type)

Method Summary

Modifier and Type	Method	Description
boolean	checkTimedOut()
Long	checkTimeLeftInMilliseconds()
protected long	elapsedTimeInMilliseconds()
void	forceTimedOut()
boolean	hasHardTimeout()
boolean	isTimedOut()
protected void	onTimedOut()
Long	remainingTimeToHardTimeout()	If no hard timeout is defined, returns null.
void	start()	we start counting from this method call (if needed)
void	stop()
long	timeoutBaseline()
Duration	tookTime()

Methods inherited from class java.lang.Object

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

Field Detail

timingSource

protected final TimingSource timingSource

timeoutMs

protected final Long timeoutMs

type

protected final TimeoutManager.Type type

Constructor Detail

TimeoutManager

public TimeoutManager(TimingSource timingSource,
                      Long timeoutMs,
                      TimeoutManager.Type type)

Method Detail

start

public void start()

we start counting from this method call (if needed)

stop

public void stop()

remainingTimeToHardTimeout

public Long remainingTimeToHardTimeout()

If no hard timeout is defined, returns null.

Returns:

the remaining time to hard timeout in milliseconds

Throws:

SearchTimeoutException - If the timeout was reached and a hard timeout was requested.

timeoutBaseline

public long timeoutBaseline()

checkTimeLeftInMilliseconds

public Long checkTimeLeftInMilliseconds()

Returns:

true if the timeout was reached, false otherwise.

Throws:

SearchTimeoutException - If the timeout was reached and a hard timeout was requested.

isTimedOut

public boolean isTimedOut()

Returns:

true if the timeout was reached in a previous call to checkTimedOut(), false otherwise.

checkTimedOut

public boolean checkTimedOut()

Returns:

true if the timeout was reached, false otherwise.

Throws:

SearchTimeoutException - If the timeout was reached and a hard timeout was requested.

forceTimedOut

public void forceTimedOut()

hasHardTimeout

public boolean hasHardTimeout()

tookTime

public Duration tookTime()

onTimedOut

protected void onTimedOut()

elapsedTimeInMilliseconds

protected long elapsedTimeInMilliseconds()