Created
June 12, 2012 17:45
-
-
Save AnthonyMastrean/2918977 to your computer and use it in GitHub Desktop.
Timed Lock
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// http://www.interact-sw.co.uk/iangblog/2004/04/26/yetmoretimedlocking | |
using System; | |
using System.Threading; | |
// Thanks to Eric Gunnerson for recommending this be a struct rather | |
// than a class - avoids a heap allocation. | |
// Thanks to Change Gillespie and Jocelyn Coulmance for pointing out | |
// the bugs that then crept in when I changed it to use struct... | |
// Thanks to John Sands for providing the necessary incentive to make | |
// me invent a way of using a struct in both release and debug builds | |
// without losing the debug leak tracking. | |
public struct TimedLock : IDisposable | |
{ | |
public static TimedLock Lock (object o) | |
{ | |
return Lock (o, TimeSpan.FromSeconds (10)); | |
} | |
public static TimedLock Lock (object o, TimeSpan timeout) | |
{ | |
TimedLock tl = new TimedLock (o); | |
if (!Monitor.TryEnter (o, timeout)) | |
{ | |
#if DEBUG | |
System.GC.SuppressFinalize(tl.leakDetector); | |
#endif | |
throw new LockTimeoutException (); | |
} | |
return tl; | |
} | |
private TimedLock (object o) | |
{ | |
target = o; | |
#if DEBUG | |
leakDetector = new Sentinel(); | |
#endif | |
} | |
private object target; | |
public void Dispose () | |
{ | |
Monitor.Exit (target); | |
// It's a bad error if someone forgets to call Dispose, | |
// so in Debug builds, we put a finalizer in to detect | |
// the error. If Dispose is called, we suppress the | |
// finalizer. | |
#if DEBUG | |
GC.SuppressFinalize(leakDetector); | |
#endif | |
} | |
#if DEBUG | |
// (In Debug mode, we make it a class so that we can add a finalizer | |
// in order to detect when the object is not freed.) | |
private class Sentinel | |
{ | |
~Sentinel() | |
{ | |
// If this finalizer runs, someone somewhere failed to | |
// call Dispose, which means we've failed to leave | |
// a monitor! | |
System.Diagnostics.Debug.Fail("Undisposed lock"); | |
} | |
} | |
private Sentinel leakDetector; | |
#endif | |
} | |
public class LockTimeoutException : ApplicationException | |
{ | |
public LockTimeoutException () : base("Timeout waiting for lock") | |
{ | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Future: http://www.interact-sw.co.uk/iangblog/2004/05/12/timedlockstacktrace