ThreadTimeout Class |
14c (14.1.1.0)
F23534-02
ThreadTimeout provides a mechanism for allowing a thread to interrupt itself if it doesn't return
to a specific call site within a given timeout. ThreadTimeout instances are intended to be
used with a using Statement. Once constructed a ThreadTimeout attempts to ensure that
the corresponding using block completes within the specified timeout and if it
does not the thread will self-interrupt. Exiting the timeout block will automatically clear
any interrupt present on the thread and in such a case a ThreadInterruptedException will be thrown.
Inheritance HierarchyNamespace: Tangosol.Util
Assembly: Coherence (in Coherence.dll) Version: 14.1.1.14 (14.1.1.14)
SyntaxC#
public class ThreadTimeout : IDisposable
The ThreadTimeout type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ThreadTimeout |
Specify a new timeout.
|
Properties| Name | Description | |
|---|---|---|
  | IsTimedOut |
Whether the calling thread is timed out.
|
| RemainingTimeoutMillis |
The number of remaining milliseconds before this thread will time out,
0 if timed out, or MaxValue if disabled.
|
Methods| Name | Description | |
|---|---|---|
 | After(Int32) |
Specify a new timeout. Note that the calling thread's timeout will only be
changed if the specified timeout is less then any existing timeout already
active on the thread.
|
| After(TimeSpan) |
Specify a new timeout. Note that the calling thread's timeout will only be
changed if the specified timeout is less than any existing timeout already
active on the thread.
|
| Dispose |
As part of closing the ThreadTimeout resource any former timeout will be restored.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Override |
Specify a new timeout, potentially extending an already active timeout.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | f_cMillisTimeout |
This ThreadTimeout's timeout.
|
| f_lhTimeout |
Cached reference to the thread's ThreadTimeoutLongHolder holding it's current timeout.
|
| f_lTimeoutOrig |
The original timeout before this instance changed it.
|
| f_tloCreator |
True iff this Timeout created (and thus must ultimately destroy) the TLO.
|
| s_tloTimeout |
A thread-local containing the calling thread's timeout value. Values which are greater or equal to zero
are used to indicate timeout timestamps. Negative values are relative timeouts which haven't yet been
realized into a timestamp. This allows for an optimization where we can avoid obtaining
the current time when "setting" the timeout, and defer it until we are about to block.
|
RemarksExamples
try
{
using (ThreadTimeout t = ThreadTimeout.After(5000))
{
DoSomething();
} // this thread will self-interrupt if it doesn't reach this line within 5 seconds
}
catch (ThreadInterruptedException e)
{
// thread timed out or was otherwise interrupted
}
In order for this to work any blocking code executed from within the context of the Timeout must use the
Blocking static helper methods for blocking. An example of a compatible blocking call would be:
Examples
void DoSomething()
{
Object oField = m_oField;
using (BlockingLock l = BlockingLock.Lock(oField)) // rather than lock (oField)
{
Blocking.Wait(oField); // rather than Monitor.Wait(oField);
}
}
Note that ThreadTimeout can only self-interrupt at interruptible points, and does not defend against
CPU bound loops for example.
See Also