Merge branch 'main' of https://github.com/specklesystems/GrasshopperAsyncComponent into main

closes #7

GrasshopperAsyncComponent/GH_AsyncComponent.cs

@@ -86,24 +86,6 @@ namespace GrasshopperAsyncComponent
       Tasks = new List<Task>();
     }
 
-    public void RequestCancellation()
-    {
-      foreach(var token in CancellationSources)
-      {
-        token.Cancel();
-      }
-
-      CancellationSources.Clear();
-      Workers.Clear();
-      ProgressReports.Clear();
-      Tasks.Clear();
-
-      Interlocked.Exchange(ref SetData, 0);
-
-      Message = "Done";
-      OnDisplayExpired(true);
-    }
-
     public virtual void DisplayProgress(object sender, System.Timers.ElapsedEventArgs e)
     {
       if (Workers.Count == 0 || ProgressReports.Values.Count == 0)

GrasshopperAsyncComponent/GrasshopperAsyncComponent.nuspec

@@ -2,14 +2,14 @@
 <package >
   <metadata>
     <id>GrasshopperAsyncComponent</id>
-    <version>0.2.1.0</version>
+    <version>1.2.2.0</version>
     <title>GrasshopperAsyncComponent</title>
     <authors>Speckle Systems</authors>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <license type="expression">Apache-2.0</license>
     <projectUrl>https://github.com/specklesystems/GrasshopperAsyncComponent</projectUrl>
     <description>Jankless Grasshopper Component</description>
-    <releaseNotes>Hotfix for race condition preventing full component cycle.</releaseNotes>
+    <releaseNotes>Adds cancellation methods.</releaseNotes>
     <copyright>Speckle Systems</copyright>
     <tags>grasshopper rhino mcneel gh_component</tags>
   </metadata>

GrasshopperAsyncComponent/Properties/AssemblyInfo.cs

@@ -9,7 +9,7 @@ using System.Runtime.InteropServices;
 [assembly: AssemblyConfiguration("")]
 [assembly: AssemblyCompany("Speckle Systems")]
 [assembly: AssemblyProduct("GrasshopperAsyncComponent")]
-[assembly: AssemblyCopyright("Copyright ©  2020")]
+[assembly: AssemblyCopyright("Copyright AEC Systems © 2020, 2021")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 
@@ -31,5 +31,5 @@ using System.Runtime.InteropServices;
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.0.0.0")]
-[assembly: AssemblyFileVersion("1.0.0.0")]
+[assembly: AssemblyVersion("1.2.2.0")]
+[assembly: AssemblyFileVersion("1.2.2.0")]

GrasshopperAsyncComponentDemo/SampleImplementations/Sample_PrimeCalculatorAsyncComponent.cs

@@ -33,15 +33,6 @@ namespace GrasshopperAsyncComponentDemo.SampleImplementations
       pManager.AddNumberParameter("Output", "O", "The n-th prime number.", GH_ParamAccess.item);
     }
 
-    protected override void AppendAdditionalComponentMenuItems(ToolStripDropDown menu)
-    {
-      base.AppendAdditionalComponentMenuItems(menu);
-      Menu_AppendItem(menu, "Cancel", (s, e) =>
-      {
-        this.RequestCancellation();
-      });
-    }
-
     public override void AppendAdditionalMenuItems(ToolStripDropDown menu)
     {
       base.AppendAdditionalMenuItems(menu);
@@ -62,7 +53,7 @@ namespace GrasshopperAsyncComponentDemo.SampleImplementations
     public override void DoWork(Action<string, double> ReportProgress, Action Done)
     {
       // 👉 Checking for cancellation!
-      if (CancellationToken.IsCancellationRequested) { Done(); return; }
+      if (CancellationToken.IsCancellationRequested) { return; }
 
       int count = 0;
       long a = 2;
@@ -71,14 +62,14 @@ namespace GrasshopperAsyncComponentDemo.SampleImplementations
       while (count < TheNthPrime)
       {
         // 👉 Checking for cancellation!
-        if (CancellationToken.IsCancellationRequested) { Done(); return; }
+        if (CancellationToken.IsCancellationRequested) {  return; }
 
         long b = 2;
         int prime = 1;// to check if found a prime
         while (b * b <= a)
         {
           // 👉 Checking for cancellation!
-          if (CancellationToken.IsCancellationRequested) { Done(); return; }
+          if (CancellationToken.IsCancellationRequested) {return; }
 
           if (a % b == 0)
           {

GrasshopperAsyncComponentDemo/SampleImplementations/Sample_UslessCyclesComponent.cs

@@ -52,7 +52,7 @@ namespace GrasshopperAsyncComponentDemo.SampleImplementations
     public override void DoWork(Action<string, double> ReportProgress, Action Done)
     {
       // Checking for cancellation
-      if (CancellationToken.IsCancellationRequested) { Done(); return; }
+      if (CancellationToken.IsCancellationRequested) { return; }
 
       for (int i = 0; i <= MaxIterations; i++)
       {
@@ -63,7 +63,7 @@ namespace GrasshopperAsyncComponentDemo.SampleImplementations
         ReportProgress(Id, ((double)(i + 1) / (double)MaxIterations));
 
         // Checking for cancellation
-        if (CancellationToken.IsCancellationRequested) { Done(); return; }
+        if (CancellationToken.IsCancellationRequested) { return; }
       }
 
       Done();

README.md

@@ -21,9 +21,9 @@ Looks nice, doesn't it? Notice that the solution runs "eagerly" - every time the
 
 Provides an abstract `GH_AsyncComponent` which you can inherit from to scaffold your own async component. There's more info in the [blogpost](https://speckle.systems/blog/async-gh/) on how to go about it.
 
-Even better, there's a [sample component that shows how an implementation could look like](https://github.com/specklesystems/GrasshopperAsyncComponent/tree/main/GrasshopperAsyncComponent/SampleImplementations)! There's two components in that folder:
-- The Useless Spinner: does no meaningfull CPU work, just keeps a thread busy with SpinWait()
-- The N-th Prime Calculator: can actually spin your computer's fans quite a bit (for numbers > 100.000) 
+> #### Checkout the sample implementation! 
+> - [Prime number calculator](https://github.com/specklesystems/GrasshopperAsyncComponent/blob/a53cef31a8750a18d06fad0f41b2dc452fdc253b/GrasshopperAsyncComponentDemo/SampleImplementations/Sample_PrimeCalculatorAsyncComponent.cs#L11-L53) Calculates the n'th prime. Can actually spin your computer's fans quite a bit for numbers > 100.000!
+> - [Usless spinner](https://github.com/specklesystems/GrasshopperAsyncComponent/blob/2f2be53bffd2402337ba40d65bb5b619d1161b3e/GrasshopperAsyncComponentDemo/SampleImplementations/Sample_UslessCyclesComponent.cs#L13-L91) does no meaningfull CPU work, just keeps a thread busy with SpinWait().
 
 ### Current limitations