Merge pull request #84 from bonsai-rx/transport-dispose

Ensure transport is closed on shutdown IO errors
bonsai-rx · Mar 25, 2024 · eae1176 · eae1176
2 parents 76a05d7 + a71c997
commit eae1176
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 22 deletions.
diff --git a/Bonsai.Harp/Bonsai.Harp.csproj b/Bonsai.Harp/Bonsai.Harp.csproj
@@ -7,7 +7,8 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <TargetFrameworks>net462;netstandard2.0</TargetFrameworks>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
-    <VersionPrefix>3.5.1</VersionPrefix>
+    <VersionPrefix>3.5.2</VersionPrefix>
+    <VersionSuffix></VersionSuffix>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/Bonsai.Harp/Device.cs b/Bonsai.Harp/Device.cs
@@ -7,6 +7,7 @@
 using System.Xml.Serialization;
 using System.Threading.Tasks;
 using System.Threading;
+using System.IO;
 
 namespace Bonsai.Harp
 {
@@ -255,6 +256,26 @@ static IObservable<string> GetDeviceName(string portName, LedState ledState, Led
               .FirstAsync();
         }
 
+        private void CloseTransport(SerialTransport transport)
+        {
+            try
+            {
+                var writeOpCtrl = OperationControl.FromPayload(MessageType.Write, new OperationControlPayload(
+                    OperationMode.Standby,
+                    dumpRegisters: false,
+                    MuteReplies,
+                    VisualIndicators,
+                    OperationLed,
+                    Heartbeat));
+                transport.Write(writeOpCtrl);
+            }
+            catch (Exception ex) when (ex is IOException || ex is InvalidOperationException || ex is ObjectDisposedException)
+            {
+                // ignore port IO errors
+            }
+            finally { transport.Close(); }
+        }
+
         /// <summary>
         /// Connects to the specified serial port and returns an observable sequence of Harp messages
         /// coming from the device.
@@ -265,18 +286,7 @@ public override IObservable<HarpMessage> Generate()
             return Observable.Create<HarpMessage>(async (observer, cancellationToken) =>
             {
                 var transport = await CreateTransportAsync(observer, cancellationToken);
-                return Disposable.Create(() =>
-                {
-                    var writeOpCtrl = OperationControl.FromPayload(MessageType.Write, new OperationControlPayload(
-                        OperationMode.Standby,
-                        dumpRegisters: false,
-                        MuteReplies,
-                        VisualIndicators,
-                        OperationLed,
-                        Heartbeat));
-                    transport.Write(writeOpCtrl);
-                    transport.Close();
-                });
+                return Disposable.Create(() => CloseTransport(transport));
             });
         }
 
@@ -299,16 +309,8 @@ public IObservable<HarpMessage> Generate(IObservable<HarpMessage> source)
 
                 return Disposable.Create(() =>
                 {
-                    var writeOpCtrl = OperationControl.FromPayload(MessageType.Write, new OperationControlPayload(
-                        OperationMode.Standby,
-                        dumpRegisters: false,
-                        MuteReplies,
-                        VisualIndicators,
-                        OperationLed,
-                        Heartbeat));
-                    transport.Write(writeOpCtrl);
                     sourceDisposable.Dispose();
-                    transport.Close();
+                    CloseTransport(transport);
                 });
             });
         }