Triggers an interrupt on the calling thread if it doesn't complete a block.

Classes can use this to trip an alarm interrupting the calling thread if it doesn't complete a block within the specified timeout. Typical calling pattern is:

private InterruptTimer myTimer = ...;
void foo() {
  try {
    myTimer.begin(timeout);
    // work
  } finally {
    myTimer.end();
  }
}

An InterruptTimer is not recursive. To implement recursive timers, independent InterruptTimer instances are required. A single InterruptTimer may be shared between objects which won't recursively call each other.

Each InterruptTimer spawns one background thread to sleep the specified time and interrupt the thread which called begin(int). It is up to the caller to ensure that the operations within the work block between the matched begin and end calls tests the interrupt flag (most IO operations do).

To terminate the background thread, use terminate(). If the application fails to terminate the thread, it will (eventually) terminate itself when the InterruptTimer instance is garbage collected.

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	InterruptTimer.AlarmState
pack-priv static class	InterruptTimer.AlarmThread
private static class	InterruptTimer.AutoKiller

Field Summary

Modifier and Type	Field and Description
pack-priv final InterruptTimer.AutoKiller	autoKiller
private final InterruptTimer.AlarmState	state
private final InterruptTimer.AlarmThread	thread

Access	Constructor and Description
public	InterruptTimer() Create a new timer with a default thread name.
public	InterruptTimer(String name of the timer thread. threadName) Create a new timer to signal on interrupt on the caller.

Modifier and Type	Method and Description
public void	begin(int number of milliseconds before the interrupt should trigger. Must be > 0. timeout) Arm the interrupt timer before entering a blocking operation.
public void	end() Disable the interrupt timer, as the operation is complete.
public void	terminate() Shutdown the timer thread, and wait for it to terminate.

Field Detail

autoKiller	back to summary
pack-priv final InterruptTimer.AutoKiller autoKiller

state	back to summary
private final InterruptTimer.AlarmState state

thread	back to summary
private final InterruptTimer.AlarmThread thread

InterruptTimer	back to summary
public InterruptTimer() Create a new timer with a default thread name.

InterruptTimer	back to summary
public InterruptTimer(String threadName) Create a new timer to signal on interrupt on the caller. The timer thread is created in the calling thread's ThreadGroup. Parameters threadName:String name of the timer thread.

begin	back to summary
public void begin(int timeout) Arm the interrupt timer before entering a blocking operation. Parameters timeout:int number of milliseconds before the interrupt should trigger. Must be > 0.

end	back to summary
public void end() Disable the interrupt timer, as the operation is complete.

terminate	back to summary
public void terminate() Shutdown the timer thread, and wait for it to terminate.

org.eclipse.jgit.util.io back to summary

pack-priv final Class InterruptTimer.AlarmState

Class Inheritance

extends Object
implements Runnable

java.lang.Object
org.eclipse.jgit.util.io.InterruptTimer.AlarmState

All Implemented Interfaces

java.lang.Runnable

Field Summary

Modifier and Type	Field and Description
private Thread	callingThread
private long	deadline
private boolean	terminated

Constructor Summary

Access	Constructor and Description
pack-priv	AlarmState()

Method Summary

Modifier and Type	Method and Description
pack-priv synchronized void	begin(int timeout)
pack-priv synchronized void	end()
private static long	now()
public synchronized void	run() Implements java.lang.Runnable.run. Runs this operation.
pack-priv synchronized void	terminate()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

callingThread	back to summary
private Thread callingThread

deadline	back to summary
private long deadline

terminated	back to summary
private boolean terminated

Constructor Detail

AlarmState	back to summary
pack-priv AlarmState()

Method Detail

begin	back to summary
pack-priv synchronized void begin(int timeout)

end	back to summary
pack-priv synchronized void end()

now	back to summary
private static long now()

run	back to summary
public synchronized void run() Implements java.lang.Runnable.run. Doc from java.lang.Runnable.run. Runs this operation. Annotations @Override

run

back to summary

public synchronized void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

terminate	back to summary
pack-priv synchronized void terminate()

org.eclipse.jgit.util.io back to summary

pack-priv final Class InterruptTimer.AlarmThread

Class Inheritance

extends Thread

java.lang.Object
java.lang.Thread
org.eclipse.jgit.util.io.InterruptTimer.AlarmThread

Field Summary

Inherited from java.lang.Thread:: MAX_PRIORITY MIN_PRIORITY NORM_PRIORITY

Constructor Summary

Access	Constructor and Description
pack-priv	AlarmThread(String name, InterruptTimer.AlarmState q)

Method Summary

Constructor Detail

AlarmThread	back to summary
pack-priv AlarmThread(String name, InterruptTimer.AlarmState q)

org.eclipse.jgit.util.io back to summary

private final Class InterruptTimer.AutoKiller

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jgit.util.io.InterruptTimer.AutoKiller

Field Summary

Modifier and Type	Field and Description
private final InterruptTimer.AlarmState	state

Constructor Summary

Access	Constructor and Description
pack-priv	AutoKiller(InterruptTimer.AlarmState s)

Method Summary

Modifier and Type	Method and Description
protected void	finalize() Overrides java.lang.Object.finalize. Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Inherited from java.lang.Object:: clone equals getClass hashCode notify notifyAll toString wait wait wait

Field Detail

state	back to summary
private final InterruptTimer.AlarmState state

Constructor Detail

AutoKiller	back to summary
pack-priv AutoKiller(InterruptTimer.AlarmState s)

Method Detail

finalize back to summary

finalize	back to summary
protected void finalize() throws Throwable Overrides java.lang.Object.finalize. Doc from java.lang.Object.finalize. Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the `finalize` method to dispose of system resources or to perform other cleanup. When running in a Java virtual machine in which finalization has been disabled or removed, the garbage collector will never call `finalize()`. In a Java virtual machine in which finalization is enabled, the garbage collector might call `finalize` only after an indefinite delay. The general contract of `finalize` is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The `finalize` method may take any action, including making this object available again to other threads; the usual purpose of `finalize`, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded. The `finalize` method of class `Object` performs no special action; it simply returns normally. Subclasses of `Object` may override this definition. The Java programming language does not guarantee which thread will invoke the `finalize` method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates. After the `finalize` method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded. The `finalize` method is never invoked more than once by a Java virtual machine for any given object. Any exception thrown by the `finalize` method causes the finalization of this object to be halted, but is otherwise ignored. Annotations @Override Exceptions Throwable: the `Exception` raised by this method

protected void finalize() throws Throwable

Overrides java.lang.Object.finalize.

Doc from java.lang.Object.finalize.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

When running in a Java virtual machine in which finalization has been disabled or removed, the garbage collector will never call finalize(). In a Java virtual machine in which finalization is enabled, the garbage collector might call finalize only after an indefinite delay.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Annotations

@Override

Exceptions

Throwable:: the Exception raised by this method

public final Class InterruptTimer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class InterruptTimer.AlarmState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class InterruptTimer.AlarmThread

Field Summary

Constructor Summary

Method Summary

Constructor Detail

private final Class InterruptTimer.AutoKiller

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail