Adding support for monitoring changes to connections.

DotRas.sln

@@ -3,18 +3,14 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 15
 VisualStudioVersion = 15.0.27428.2037
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "1. Tests", "1. Tests", "{9D34A309-06DD-4B78-9424-672421884BCB}"
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "2. Tests", "2. Tests", "{9D34A309-06DD-4B78-9424-672421884BCB}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{C1AE3EAA-AFFF-4D81-8BAF-53A000F40235}"
 	ProjectSection(SolutionItems) = preProject
 		.gitignore = .gitignore
 		AnyCPU.runsettings = AnyCPU.runsettings
 	EndProjectSection
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "2. Runner", "2. Runner", "{6908689B-72AB-4390-BDAA-857EA62E925A}"
-EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ConsoleRunner", "test\ConsoleRunner\ConsoleRunner.csproj", "{82CDADEF-9BA9-480C-A059-DAF35FD69B08}"
-EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DotRas", "src\DotRas\DotRas.csproj", "{DA4B359A-F13F-46FE-81C4-FCD6EB7EB2CA}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DotRas.Tests", "test\DotRas.Tests\DotRas.Tests.csproj", "{1F46ADDE-3E40-4BB3-B933-11DD919839AE}"
@@ -33,16 +29,20 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Includes", "Includes", "{48
 		includes\um\winnt.h = includes\um\winnt.h
 	EndProjectSection
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "3. Tools", "3. Tools", "{B3BCF167-8512-4154-A462-5BC1F7B1925F}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ConsoleRunner", "tools\ConsoleRunner\ConsoleRunner.csproj", "{82CDADEF-9BA9-480C-A059-DAF35FD69B08}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "1. Examples", "1. Examples", "{C342DFB6-A477-4974-B389-102D84DD4F2E}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WatchConnectionsForChanges", "examples\WatchConnectionsForChanges\WatchConnectionsForChanges.csproj", "{A3DE66F4-33AD-4F63-A989-7382CC4CEA42}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
 		Release|Any CPU = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{82CDADEF-9BA9-480C-A059-DAF35FD69B08}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{82CDADEF-9BA9-480C-A059-DAF35FD69B08}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{82CDADEF-9BA9-480C-A059-DAF35FD69B08}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{82CDADEF-9BA9-480C-A059-DAF35FD69B08}.Release|Any CPU.Build.0 = Release|Any CPU
 		{DA4B359A-F13F-46FE-81C4-FCD6EB7EB2CA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{DA4B359A-F13F-46FE-81C4-FCD6EB7EB2CA}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{DA4B359A-F13F-46FE-81C4-FCD6EB7EB2CA}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -51,14 +51,23 @@ Global
 		{1F46ADDE-3E40-4BB3-B933-11DD919839AE}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{1F46ADDE-3E40-4BB3-B933-11DD919839AE}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{1F46ADDE-3E40-4BB3-B933-11DD919839AE}.Release|Any CPU.Build.0 = Release|Any CPU
+		{82CDADEF-9BA9-480C-A059-DAF35FD69B08}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{82CDADEF-9BA9-480C-A059-DAF35FD69B08}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{82CDADEF-9BA9-480C-A059-DAF35FD69B08}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{82CDADEF-9BA9-480C-A059-DAF35FD69B08}.Release|Any CPU.Build.0 = Release|Any CPU
+		{A3DE66F4-33AD-4F63-A989-7382CC4CEA42}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A3DE66F4-33AD-4F63-A989-7382CC4CEA42}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A3DE66F4-33AD-4F63-A989-7382CC4CEA42}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A3DE66F4-33AD-4F63-A989-7382CC4CEA42}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
-		{82CDADEF-9BA9-480C-A059-DAF35FD69B08} = {6908689B-72AB-4390-BDAA-857EA62E925A}
 		{1F46ADDE-3E40-4BB3-B933-11DD919839AE} = {9D34A309-06DD-4B78-9424-672421884BCB}
 		{48D5F528-BF5E-4B79-B6A2-3CD77E28C482} = {C1AE3EAA-AFFF-4D81-8BAF-53A000F40235}
+		{82CDADEF-9BA9-480C-A059-DAF35FD69B08} = {B3BCF167-8512-4154-A462-5BC1F7B1925F}
+		{A3DE66F4-33AD-4F63-A989-7382CC4CEA42} = {C342DFB6-A477-4974-B389-102D84DD4F2E}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {3BBA19DF-42BF-442B-95C4-17D4A554714E}

examples/WatchConnectionsForChanges/App.config

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<configuration>
+    <startup> 
+        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.7.1" />
+    </startup>
+</configuration>

examples/WatchConnectionsForChanges/Program.cs

@@ -0,0 +1,87 @@
+using System;
+using DotRas;
+
+namespace WatchConnectionsForChanges
+{
+    internal class Program : IDisposable
+    {
+        private readonly RasConnectionWatcher watcher;
+
+        public static void Main(string[] args)
+        {
+            try
+            {
+                using (var p = new Program())
+                {
+                    p.Run();
+                }
+            }
+            catch (Exception ex)
+            {
+                Console.WriteLine(ex);
+            }
+
+            Console.WriteLine("Press any key to terminate...");
+            Console.ReadKey(true);
+        }
+
+        public Program()
+        {
+            watcher = new RasConnectionWatcher();
+
+            watcher.Connected += OnConnectionConnected;
+            watcher.Disconnected += OnConnectionDisconnected;
+        }
+
+        ~Program()
+        {
+            Dispose(false);
+        }        
+
+        /// <summary>
+        /// This method gets called when the operating system notifies DotRas that a new connection has been established.
+        /// </summary>
+        /// <param name="sender">This is the object which raised the event.</param>
+        /// <param name="e">This object carries the event data.</param>
+        private void OnConnectionConnected(object sender, RasConnectionEventArgs e)
+        {
+            Console.WriteLine($"Connected: {e.ConnectionInformation.EntryName}");
+        }
+
+        /// <summary>
+        /// This method gets called when the operating system notifies DotRas that an existing connection has disconnected.
+        /// </summary>
+        /// <param name="sender">This is the object which raised the event.</param>
+        /// <param name="e">This object carries the event data.</param>
+        private void OnConnectionDisconnected(object sender, RasConnectionEventArgs e)
+        {
+            Console.WriteLine($"Disconnected: {e.ConnectionInformation.EntryName}");
+        }
+
+        private void Run()
+        {
+            // Start watching for connection changes.
+            watcher.Start();
+
+            Console.WriteLine("Press any key to stop watching for connection changes...");
+            Console.ReadKey(true);
+
+            // Stop watching for connection changes.
+            watcher.Stop();
+        }
+
+        public void Dispose()
+        {
+            Dispose(true);
+            GC.SuppressFinalize(this);
+        }
+
+        private void Dispose(bool disposing)
+        {
+            if (disposing)
+            {
+                watcher.Dispose();            
+            }
+        }
+    }
+}

examples/WatchConnectionsForChanges/WatchConnectionsForChanges.csproj

@@ -0,0 +1,19 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net471</TargetFramework>
+    <ApplicationIcon />
+    <OutputType>Exe</OutputType>
+    <StartupObject />
+    <AssemblyName>WatchConnectionsForChanges</AssemblyName>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\DotRas\DotRas.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Folder Include="Properties\" />
+  </ItemGroup>
+
+</Project>

src/DotRas/DisposableObject.cs

@@ -29,6 +29,11 @@ public void Dispose()
 
             lock (SyncRoot)
             {
+                if (disposed)
+                {
+                    return;
+                }
+
                 Dispose(true);
                 GC.SuppressFinalize(this);
             }

src/DotRas/ErrorEventArgs.cs

@@ -0,0 +1,30 @@
+using System;
+
+namespace DotRas
+{
+    /// <summary>
+    /// Contains event data for error events.
+    /// </summary>
+    public class ErrorEventArgs : EventArgs
+    {
+        private readonly Exception error;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ErrorEventArgs"/> class.
+        /// </summary>
+        /// <param name="error">The exception which occurred.</param>
+        public ErrorEventArgs(Exception error)
+        {
+            this.error = error ?? throw new ArgumentNullException(nameof(error));
+        }
+
+        /// <summary>
+        /// Gets the exception which occurred.
+        /// </summary>
+        /// <returns>The exception which occurred.</returns>
+        public Exception GetException()
+        {
+            return error;
+        }
+    }
+}

src/DotRas/Internal/Abstractions/Factories/IRegisteredCallbackFactory.cs

@@ -0,0 +1,10 @@
+using System.Threading;
+using DotRas.Internal.Abstractions.Primitives;
+
+namespace DotRas.Internal.Abstractions.Factories
+{
+    internal interface IRegisteredCallbackFactory
+    {
+        IRegisteredCallback Create(WaitOrTimerCallback callback, object state);
+    }
+}

src/DotRas/Internal/Abstractions/Primitives/IManualResetEvent.cs

@@ -1,8 +1,9 @@
-using System.Threading;
+using System;
+using System.Threading;
 
 namespace DotRas.Internal.Abstractions.Primitives
 {
-    internal interface IManualResetEvent
+    internal interface IManualResetEvent : IDisposable
     {
         void Set();
         void Reset();

src/DotRas/Internal/Abstractions/Primitives/IRegisteredCallback.cs

@@ -0,0 +1,10 @@
+using System;
+using Microsoft.Win32.SafeHandles;
+
+namespace DotRas.Internal.Abstractions.Primitives
+{
+    internal interface IRegisteredCallback : IDisposable
+    {
+        SafeWaitHandle Handle { get; }
+    }
+}

src/DotRas/Internal/Abstractions/Primitives/ITaskCancellationSource.cs

@@ -3,7 +3,7 @@
 
 namespace DotRas.Internal.Abstractions.Primitives
 {
-    internal interface ITaskCancellationSource
+    internal interface ITaskCancellationSource : IDisposable
     {
         CancellationToken Token { get; }
 

src/DotRas/Internal/Abstractions/Primitives/IValueWaiter.cs

@@ -1,8 +1,9 @@
-using System.Threading;
+using System;
+using System.Threading;
 
 namespace DotRas.Internal.Abstractions.Primitives
 {
-    internal interface IValueWaiter<T>
+    internal interface IValueWaiter<T> : IDisposable
     {
         T Value { get; }
         bool IsSet { get; }

src/DotRas/Internal/Abstractions/Services/IRasConnectionNotification.cs

@@ -0,0 +1,12 @@
+using System;
+
+namespace DotRas.Internal.Abstractions.Services
+{
+    internal interface IRasConnectionNotification : IDisposable
+    {
+        bool IsActive { get; }
+
+        void Subscribe(RasNotificationContext context);
+        void Reset();
+    }
+}

src/DotRas/Internal/Abstractions/Services/IRasConnectionNotificationCallbackHandler.cs

@@ -0,0 +1,8 @@
+namespace DotRas.Internal.Abstractions.Services
+{
+    internal interface IRasConnectionNotificationCallbackHandler
+    {
+        void Initialize();
+        void OnCallback(object obj, bool timedOut);
+    }
+}

src/DotRas/Internal/Abstractions/Services/IRasDial.cs

@@ -1,8 +1,9 @@
-using System.Threading.Tasks;
+using System;
+using System.Threading.Tasks;
 
 namespace DotRas.Internal.Abstractions.Services
 {
-    internal interface IRasDial
+    internal interface IRasDial : IDisposable
     {
         bool IsBusy { get; }
         Task<RasConnection> DialAsync(RasDialContext context);

src/DotRas/Internal/Abstractions/Services/IRasDialCallbackHandler.cs

@@ -4,7 +4,7 @@
 
 namespace DotRas.Internal.Abstractions.Services
 {
-    internal interface IRasDialCallbackHandler
+    internal interface IRasDialCallbackHandler : IDisposable
     {
         void Initialize(ITaskCompletionSource<RasConnection> completionSource, Action<StateChangedEventArgs> onStateChangedCallback, Action onCompletedCallback, CancellationToken cancellationToken);
 

src/DotRas/Internal/Abstractions/Services/RasDialContext.cs

@@ -4,7 +4,7 @@
 
 namespace DotRas.Internal.Abstractions.Services
 {
-    internal struct RasDialContext
+    internal class RasDialContext
     {
         public string PhoneBookPath { get; set; }
         public string EntryName { get; set; }

src/DotRas/Internal/Abstractions/Services/RasNotificationContext.cs

@@ -0,0 +1,12 @@
+using System;
+
+namespace DotRas.Internal.Abstractions.Services
+{
+    internal class RasNotificationContext
+    {
+        public IRasConnection Connection { get; set; }
+
+        public Action<RasConnectionEventArgs> OnConnectedCallback { get; set; }
+        public Action<RasConnectionEventArgs> OnDisconnectedCallback { get; set; }
+    }
+}