introduce dispose pattern

Author: tg123

src/KubernetesClient/StreamDemuxer.cs

@@ -29,6 +29,7 @@ public class StreamDemuxer : IStreamDemuxer
         private readonly StreamType streamType;
         private readonly bool ownsSocket;
         private Task runLoop;
+        private bool disposedValue;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="StreamDemuxer"/> class.
@@ -61,29 +62,7 @@ public void Start()
             this.runLoop = Task.Run(async () => await RunLoop(cts.Token).ConfigureAwait(false));
         }
 
-        /// <inheritdoc/>
-        public void Dispose()
-        {
-            try
-            {
-                if (this.runLoop != null)
-                {
-                    this.cts.Cancel();
-                    this.runLoop.Wait();
-                }
-            }
-            catch (Exception ex)
-            {
-                // Dispose methods can never throw.
-                Debug.Write(ex);
-            }
-
-            if (this.ownsSocket)
-            {
-                this.webSocket.Dispose();
-            }
-        }
-
+      
         /// <summary>
         /// Gets a <see cref="Stream"/> which allows you to read to and/or write from a remote channel.
         /// </summary>
@@ -276,5 +255,49 @@ protected async Task RunLoop(CancellationToken cancellationToken)
                 this.ConnectionClosed?.Invoke(this, EventArgs.Empty);
             }
         }
+
+        protected virtual void Dispose(bool disposing)
+        {
+            if (!disposedValue)
+            {
+                if (disposing)
+                {
+                    try
+                    {
+                        if (this.runLoop != null)
+                        {
+                            this.cts.Cancel();
+                            this.runLoop.Wait();
+                        }
+                    }
+                    catch (Exception ex)
+                    {
+                        // Dispose methods can never throw.
+                        Debug.Write(ex);
+                    }
+
+                    if (this.ownsSocket)
+                    {
+                        this.webSocket.Dispose();
+                    }
+                }
+
+                disposedValue = true;
+            }
+        }
+
+        // // TODO: override finalizer only if 'Dispose(bool disposing)' has code to free unmanaged resources
+        // ~StreamDemuxer()
+        // {
+        //     // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
+        //     Dispose(disposing: false);
+        // }
+
+        public void Dispose()
+        {
+            // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
+            Dispose(disposing: true);
+            GC.SuppressFinalize(this);
+        }
     }
 }

src/KubernetesClient/Watcher.cs

@@ -42,6 +42,7 @@ public class Watcher<T> : IDisposable
         private readonly Func<Task<TextReader>> _streamReaderCreator;
 
         private TextReader _streamReader;
+        private bool disposedValue;
         private readonly Task _watcherLoop;
 
         /// <summary>
@@ -94,13 +95,6 @@ public Watcher(Func<Task<TextReader>> streamReaderCreator, Action<WatchEventType
             _watcherLoop = Task.Run(async () => await WatcherLoop(_cts.Token).ConfigureAwait(false));
         }
 
-        /// <inheritdoc/>
-        public void Dispose()
-        {
-            _cts.Cancel();
-            _streamReader?.Dispose();
-        }
-
         /// <summary>
         /// add/remove callbacks when any event raised from api server
         /// </summary>
@@ -174,5 +168,33 @@ private async Task WatcherLoop(CancellationToken cancellationToken)
                 OnClosed?.Invoke();
             }
         }
+
+        protected virtual void Dispose(bool disposing)
+        {
+            if (!disposedValue)
+            {
+                if (disposing)
+                {
+                    _cts.Cancel();
+                    _streamReader?.Dispose();
+                }
+
+                disposedValue = true;
+            }
+        }
+
+        // // TODO: override finalizer only if 'Dispose(bool disposing)' has code to free unmanaged resources
+        // ~Watcher()
+        // {
+        //     // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
+        //     Dispose(disposing: false);
+        // }
+
+        public void Dispose()
+        {
+            // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
+            Dispose(disposing: true);
+            GC.SuppressFinalize(this);
+        }
     }
 }

tests/KubernetesClient.Tests/WebSocketTestBase.cs

@@ -25,7 +25,7 @@ public abstract class WebSocketTestBase : IDisposable
         ///     The next server port to use.
         /// </summary>
         private static int nextPort = 13255;
-
+        private bool disposedValue;
         private readonly ITestOutputHelper testOutput;
 
         /// <summary>
@@ -315,11 +315,7 @@ await webSocket.SendAsync(sendBuffer, WebSocketMessageType.Binary,
                 totalBytes: receivedData.Length);
         }
 
-        public void Dispose()
-        {
-            this.CancellationSource.Dispose();
-            this.Host.Dispose();
-        }
+     
 
         /// <summary>
         ///     A <see cref="ServiceClientCredentials"/> implementation representing no credentials (i.e. anonymous).
@@ -350,5 +346,33 @@ protected static class EventIds
             /// </summary>
             private static readonly EventId ErrorClosingServerSocket = new EventId(1000, nameof(ErrorClosingServerSocket));
         }
+
+        protected virtual void Dispose(bool disposing)
+        {
+            if (!disposedValue)
+            {
+                if (disposing)
+                {
+                    CancellationSource.Dispose();
+                    Host.Dispose();
+                }
+
+                disposedValue = true;
+            }
+        }
+
+        // // TODO: override finalizer only if 'Dispose(bool disposing)' has code to free unmanaged resources
+        // ~WebSocketTestBase()
+        // {
+        //     // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
+        //     Dispose(disposing: false);
+        // }
+
+        public void Dispose()
+        {
+            // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
+            Dispose(disposing: true);
+            GC.SuppressFinalize(this);
+        }
     }
 }