Mercurial > pub > ImplabNet
annotate Implab/Components/Disposable.cs @ 212:a01d9df88d74 v2
Added class Trace<T> to manage channels for individual classes, if SomeClass
uses Trace<SomeClass> it sould be marked with TraceSourceAttribute
| author | cin |
|---|---|
| date | Tue, 04 Apr 2017 12:04:05 +0300 |
| parents | 7d07503621fe |
| children | 9ee78a345738 |
| rev | line source |
|---|---|
| 152 | 1 using Implab.Diagnostics; |
| 2 using System; | |
|
208
7d07503621fe
RunnableComponent.Dispose(bool,Exception) changed to standart Dispose(bool)
cin
parents:
152
diff
changeset
|
3 using System.Diagnostics.CodeAnalysis; |
| 152 | 4 using System.Threading; |
| 5 | |
| 6 namespace Implab.Components { | |
| 7 /// <summary> | |
| 8 /// Base class the objects which support disposing. | |
| 9 /// </summary> | |
| 10 public class Disposable : IDisposable { | |
| 11 | |
| 12 int m_disposed; | |
| 13 | |
| 14 public event EventHandler Disposed; | |
| 15 | |
| 16 public bool IsDisposed { | |
| 17 get { | |
| 18 Thread.MemoryBarrier(); | |
| 19 return m_disposed != 0; | |
| 20 } | |
| 21 } | |
| 22 | |
| 23 /// <summary> | |
| 24 /// Asserts the object is not disposed. | |
| 25 /// </summary> | |
| 26 /// <exception cref="ObjectDisposedException">The object is disposed</exception> | |
| 27 /// <remarks> | |
| 28 /// Успешная проверка того, что объект не освобожден еще не гарантирует, что он не | |
| 29 /// будет освобожден сразу после нее, поэтому методы использующие проверку должны | |
| 30 /// учитывать, что объект может быть освобожден из параллельного потока. | |
| 31 /// Данны метод служит для упрощения отладки ошибок при использовании объекта после его | |
| 32 /// освобождения. | |
| 33 /// </remarks> | |
| 34 /// <example> | |
| 35 /// // пример синхронизированного освобождения ресурсов | |
| 36 /// class FileStore : Disposable { | |
| 37 /// readonly TextWriter m_file; | |
| 38 /// readonly obejct m_sync = new object(); | |
| 39 /// | |
| 40 /// public FileStore(string file) { | |
| 41 /// m_file = new TextWriter(File.OpenWrite(file)); | |
| 42 /// } | |
| 43 /// | |
| 44 /// public void Write(string text) { | |
| 45 /// lock(m_sync) { | |
| 46 /// AssertNotDisposed(); | |
| 47 /// m_file.Write(text); | |
| 48 /// } | |
| 49 /// } | |
| 50 /// | |
| 51 /// protected override void Dispose(bool disposing) { | |
| 52 /// if (disposing) | |
| 53 /// lock(m_sync) { | |
| 54 /// m_file.Dipose(); | |
| 55 /// base.Dispose(true); | |
| 56 /// } | |
| 57 /// else | |
| 58 /// base.Dispose(false); | |
| 59 /// } | |
| 60 /// } | |
| 61 /// <example> | |
| 62 protected void AssertNotDisposed() { | |
| 63 Thread.MemoryBarrier(); | |
| 64 if (m_disposed != 0) | |
| 65 throw new ObjectDisposedException(ToString()); | |
| 66 } | |
| 67 /// <summary> | |
| 68 /// Вызывает событие <see cref="Disposed"/> | |
| 69 /// </summary> | |
| 70 /// <param name="disposing">Признак того, что нужно освободить ресурсы, иначе данный метод | |
| 71 /// вызван сборщиком мусора и нужно освобождать ТОЛЬКО неуправляемые ресурсы ТОЛЬКО этого | |
| 72 /// объекта.</param> | |
| 73 /// <remarks> | |
| 74 /// Данный метод вызывается гарантированно один раз даже при одновременном вызове <see cref="Dispose()"/> | |
| 75 /// из нескольких потоков. | |
| 76 /// </remarks> | |
| 77 protected virtual void Dispose(bool disposing) { | |
| 78 if (disposing) { | |
| 79 EventHandler temp = Disposed; | |
| 80 if (temp != null) | |
| 81 temp(this, EventArgs.Empty); | |
| 82 } | |
| 83 } | |
| 84 | |
|
208
7d07503621fe
RunnableComponent.Dispose(bool,Exception) changed to standart Dispose(bool)
cin
parents:
152
diff
changeset
|
85 [SuppressMessage("Microsoft.Design", "CA1063:ImplementIDisposableCorrectly", Justification = "Dipose(bool) and GC.SuppessFinalize are called")] |
| 152 | 86 public void Dispose() { |
| 87 if (Interlocked.Increment(ref m_disposed) == 1) { | |
| 88 Dispose(true); | |
| 89 GC.SuppressFinalize(this); | |
| 90 } | |
| 91 } | |
| 92 | |
| 93 /// <summary> | |
| 94 /// Записывает сообщение об утечке объекта. | |
| 95 /// </summary> | |
| 96 protected virtual void ReportObjectLeaks() { | |
| 97 TraceLog.TraceWarning("The object is marked as disposable but isn't disposed properly: {0}", this); | |
| 98 } | |
| 99 | |
| 100 ~Disposable() { | |
| 101 Dispose(false); | |
| 102 ReportObjectLeaks(); | |
| 103 } | |
| 104 } | |
| 105 } |