-
Notifications
You must be signed in to change notification settings - Fork 37
/
NamedLock.cs
254 lines (216 loc) · 7.82 KB
/
NamedLock.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
#region * License *
/*
SimpleHelpers - NamedLock
Copyright © 2013 Khalid Salomão
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the “Software”), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
License: http://www.opensource.org/licenses/mit-license.php
Website: https://github.com/khalidsalomao/SimpleHelpers.Net
*/
#endregion
using System;
namespace SimpleHelpers
{
/// <summary>
/// Synchronization helper: a static lock collection associated with a key.
/// NamedLock manages the lifetime of critical sections that can be accessed by a key (name) throughout the application.
/// It also have some helper methods to allow a maximum wait time (timeout) to acquire the lock and safely release it.
/// Note: this nuget package contains C# source code and depends on System.Collections.Concurrent introduced in .Net 4.0.
/// </summary>
/// <example>
/// // create a lock for this key
/// using (var padlock = new NamedLock (key))
/// {
/// if (padlock.Enter (TimeSpan.FromMilliseconds (100)))
/// {
/// // do something
/// }
/// else
/// {
/// // do some other thing
/// }
/// }
/// </example>
public class NamedLock : IDisposable
{
#region * Internal static methods *
private static readonly System.Collections.Concurrent.ConcurrentDictionary <string, CountedLock> m_waitLock = new System.Collections.Concurrent.ConcurrentDictionary<string, CountedLock> (StringComparer.Ordinal);
private static object GetOrAdd (string key)
{
CountedLock padlock = m_waitLock.GetOrAdd (key, LockFactory);
padlock.Increment ();
return padlock;
}
private static void ReleaseOrRemove (string key)
{
CountedLock padlock;
if (m_waitLock.TryGetValue (key, out padlock))
{
if (padlock.Decrement () <= 0)
m_waitLock.TryRemove (key, out padlock);
}
}
private static CountedLock LockFactory (string key)
{
return new CountedLock ();
}
class CountedLock
{
private int m_counter = 0;
public int Increment ()
{
return System.Threading.Interlocked.Increment (ref m_counter);
}
public int Decrement ()
{
return System.Threading.Interlocked.Decrement (ref m_counter);
}
}
#endregion
#region * Internal variables & properties *
private string m_key;
private object m_padlock;
private bool m_locked = false;
/// <summary>
/// Check if a lock was acquired.
/// </summary>
public bool IsLocked
{
get { return m_locked; }
}
/// <summary>
/// Gets the lock key name.
/// </summary>
public string Key
{
get { return m_key; }
}
/// <summary>
/// Gets the internal lock object.
/// </summary>
public object Lock
{
get { return m_padlock; }
}
#endregion
#region * Constructor & finalizer *
/// <summary>
/// Initializes a new instance of the <see cref="NamedLock" /> class.
/// </summary>
/// <param name="key">The named lock key.</param>
public NamedLock (string key)
{
m_key = key;
m_padlock = GetOrAdd (m_key);
}
/// <summary>
/// Performs application-defined tasks associated with freeing, releasing,
/// or resetting unmanaged resources.
/// Releases acquired lock and related resources.
/// </summary>
public void Dispose ()
{
Exit ();
ReleaseOrRemove (m_key);
}
#endregion
#region * Internal variables & properties *
/// <summary>
/// Tries to acquire a lock.
/// </summary>
public bool Enter ()
{
if (!m_locked)
{
System.Threading.Monitor.Enter (m_padlock, ref m_locked);
}
return m_locked;
}
/// <summary>
/// Tries to acquire a lock respecting the specified timeout.
/// </summary>
/// <param name="waitTimeoutMilliseconds">The wait timeout milliseconds.</param>
/// <returns>If the lock was acquired in the specified timeout</returns>
public bool Enter (int waitTimeoutMilliseconds)
{
if (!m_locked)
{
System.Threading.Monitor.TryEnter (m_padlock, waitTimeoutMilliseconds, ref m_locked);
}
return m_locked;
}
/// <summary>
/// Tries to acquire a lock respecting the specified timeout.
/// </summary>
/// <param name="waitTimeout">The wait timeout.</param>
/// <returns>If the lock was acquired in the specified timeout</returns>
public bool Enter (TimeSpan waitTimeout)
{
return Enter ((int)waitTimeout.TotalMilliseconds);
}
/// <summary>
/// Releases the lock if it was already acquired.
/// Called also at "Dispose".
/// </summary>
public bool Exit ()
{
if (m_locked)
{
m_locked = false;
System.Threading.Monitor.Exit (m_padlock);
}
return false;
}
#endregion
#region * Factory methods *
/// <summary>
/// Creates a new instance and tries to acquire a lock.
/// </summary>
/// <param name="key">The named lock key.</param>
public static NamedLock CreateAndEnter (string key)
{
NamedLock item;
item = new NamedLock (key);
item.Enter ();
return item;
}
/// <summary>
/// Creates a new instance and tries to acquire a lock.
/// </summary>
/// <param name="key">The named lock key.</param>
/// <param name="waitTimeoutMilliseconds">The wait timeout milliseconds.</param>
public static NamedLock CreateAndEnter (string key, int waitTimeoutMilliseconds)
{
NamedLock item;
item = new NamedLock (key);
item.Enter (waitTimeoutMilliseconds);
return item;
}
/// <summary>
/// Creates a new instance and tries to acquire a lock.
/// </summary>
/// <param name="key">The named lock key.</param>
/// <param name="waitTimeout">The wait timeout.</param>
public static NamedLock CreateAndEnter (string key, TimeSpan waitTimeout)
{
return CreateAndEnter (key, (int)waitTimeout.TotalMilliseconds);
}
#endregion
}
}