Merge pull request #129 from henrypinkard/main

improve shutdown behavior when writing exception happens
micro-manager · Aug 2, 2023 · bf48030 · bf48030
2 parents f1a7ab8 + f084b15
commit bf48030
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 11 deletions.
diff --git a/java/pom.xml b/java/pom.xml
@@ -2,7 +2,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>org.micro-manager.ndtiffstorage</groupId>
     <artifactId>NDTiffStorage</artifactId>
-    <version>2.13.2</version>
+    <version>2.14.0</version>
     <packaging>jar</packaging>
     <name>NDTiff Storage file format</name>
     <description>Java-based writer and reader used for NDTiffStorage format</description>

diff --git a/java/src/main/java/org/micromanager/ndtiffstorage/NDTiffAPI.java b/java/src/main/java/org/micromanager/ndtiffstorage/NDTiffAPI.java
@@ -42,6 +42,12 @@ public Future putImage(Object pixels, JSONObject metadata, HashMap<String, Objec
     */
    public boolean isFinished();
 
+   /**
+    * Throw an exception if there was an error writing to disk.
+    * This is needed because writing occurs on a seperate thread for performance reasons
+    */
+   public void checkForWritingException() throws Exception;
+
    /**
     * Set display settings for storage. No particular structure required as the
     * storage class will only save and load them but not do anything with them.

diff --git a/java/src/main/java/org/micromanager/ndtiffstorage/NDTiffStorage.java b/java/src/main/java/org/micromanager/ndtiffstorage/NDTiffStorage.java
@@ -793,12 +793,11 @@ public void discardDataForDebugging() {
    }
 
    /**
-    * Check if an exception has occured on the writing thread, and if so propagate it
-    * to other API calls
+    * Throw an exception if there was an error writing to disk
     */
-   private void checkWritingException() {
+   public void checkForWritingException() throws Exception {
       if (writingException_ != null) {
-         throw new RuntimeException(writingException_);
+         throw new Exception(writingException_);
       }
    }
 
@@ -808,7 +807,11 @@ private void checkWritingException() {
     */
    public Future putImage(Object pixels, JSONObject metadata, HashMap<String, Object> axessss,
                         boolean rgb, int bitDepth, int imageHeight, int imageWidth) {
-      checkWritingException();
+      try {
+         checkForWritingException();
+      } catch (Exception e) {
+         throw new RuntimeException(e);
+      }
       TaggedImage ti = new TaggedImage(pixels, metadata);
 
       // Make sure each axis takes all integer or all string values
@@ -904,7 +907,11 @@ static String getAxesString(HashMap<String, Object> axes) {
    @Override
    public Future putImageMultiRes( Object pixels, JSONObject metadata, final HashMap<String, Object> axes,
                                   boolean rgb, int bitDepth, int imageHeight, int imageWidth) {
-      checkWritingException();
+      try {
+         checkForWritingException();
+      } catch (Exception e) {
+         throw new RuntimeException(e);
+      }
       TaggedImage ti = new TaggedImage(pixels, metadata);
       if (!firstImageAdded_) {
          //technically this doesnt need to be parsed here, because it should be fixed for the whole
@@ -1049,10 +1056,9 @@ public void run() {
    }
 
    /**
-    * Singal to finish writing and block until everything pending is done
+    * Signal to finish writing and block until everything pending is done
     */
    public void finishedWriting()  {
-      checkWritingException();
       if (loaded_) {
          return;
       }
@@ -1139,12 +1145,10 @@ public JSONObject getDisplaySettings() {
    }
 
    public void closeAndWait() throws InterruptedException {
-      checkWritingException();
       doClose();
    }
 
    public void close() {
-      checkWritingException();
       //run close on a new thread
         new Thread(new Runnable() {
              @Override