Mercurial > pub > ImplabNet

comparison Implab/Components/Disposable.cs @ 152:240aa6994018 v2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
component model refactoring
author cin
date Thu, 11 Feb 2016 01:56:27 +0300
parents
children 7d07503621fe
comparison
equal deleted inserted replaced
151:ec91a6dfa5b3 152:240aa6994018
1 using Implab.Diagnostics;
2 using System;
3 using System.Threading;
4
5 namespace Implab.Components {
6 /// <summary>
7 /// Base class the objects which support disposing.
8 /// </summary>
9 public class Disposable : IDisposable {
10
11 int m_disposed;
12
13 public event EventHandler Disposed;
14
15 public bool IsDisposed {
16 get {
17 Thread.MemoryBarrier();
18 return m_disposed != 0;
19 }
20 }
21
22 /// <summary>
23 /// Asserts the object is not disposed.
24 /// </summary>
25 /// <exception cref="ObjectDisposedException">The object is disposed</exception>
26 /// <remarks>
27 /// Успешная проверка того, что объект не освобожден еще не гарантирует, что он не
28 /// будет освобожден сразу после нее, поэтому методы использующие проверку должны
29 /// учитывать, что объект может быть освобожден из параллельного потока.
30 /// Данны метод служит для упрощения отладки ошибок при использовании объекта после его
31 /// освобождения.
32 /// </remarks>
33 /// <example>
34 /// // пример синхронизированного освобождения ресурсов
35 /// class FileStore : Disposable {
36 /// readonly TextWriter m_file;
37 /// readonly obejct m_sync = new object();
38 ///
39 /// public FileStore(string file) {
40 /// m_file = new TextWriter(File.OpenWrite(file));
41 /// }
42 ///
43 /// public void Write(string text) {
44 /// lock(m_sync) {
45 /// AssertNotDisposed();
46 /// m_file.Write(text);
47 /// }
48 /// }
49 ///
50 /// protected override void Dispose(bool disposing) {
51 /// if (disposing)
52 /// lock(m_sync) {
53 /// m_file.Dipose();
54 /// base.Dispose(true);
55 /// }
56 /// else
57 /// base.Dispose(false);
58 /// }
59 /// }
60 /// <example>
61 protected void AssertNotDisposed() {
62 Thread.MemoryBarrier();
63 if (m_disposed != 0)
64 throw new ObjectDisposedException(ToString());
65 }
66 /// <summary>
67 /// Вызывает событие <see cref="Disposed"/>
68 /// </summary>
69 /// <param name="disposing">Признак того, что нужно освободить ресурсы, иначе данный метод
70 /// вызван сборщиком мусора и нужно освобождать ТОЛЬКО неуправляемые ресурсы ТОЛЬКО этого
71 /// объекта.</param>
72 /// <remarks>
73 /// Данный метод вызывается гарантированно один раз даже при одновременном вызове <see cref="Dispose()"/>
74 /// из нескольких потоков.
75 /// </remarks>
76 protected virtual void Dispose(bool disposing) {
77 if (disposing) {
78 EventHandler temp = Disposed;
79 if (temp != null)
80 temp(this, EventArgs.Empty);
81 }
82 }
83
84 public void Dispose() {
85 if (Interlocked.Increment(ref m_disposed) == 1) {
86 Dispose(true);
87 GC.SuppressFinalize(this);
88 }
89 }
90
91 /// <summary>
92 /// Записывает сообщение об утечке объекта.
93 /// </summary>
94 protected virtual void ReportObjectLeaks() {
95 TraceLog.TraceWarning("The object is marked as disposable but isn't disposed properly: {0}", this);
96 }
97
98 ~Disposable() {
99 Dispose(false);
100 ReportObjectLeaks();
101 }
102 }
103 }