Add in-code exaplanation for the change in cancellation signalling in STP 2.2.3. Remove left in Console.WriteLine accidentally inserted in recent 206fb306

1 files changed, 10 insertions, 0 deletions

diff --git a/ThirdParty/SmartThreadPool/WorkItem.cs b/ThirdParty/SmartThreadPool/WorkItem.cs
index f229d1f..185f10c 100644
--- a/ThirdParty/SmartThreadPool/WorkItem.cs
+++ b/ThirdParty/SmartThreadPool/WorkItem.cs
@@ -753,6 +753,16 @@ namespace Amib.Threading.Internal
                         }
                         else
                         {
+                            // **************************
+                            // Stock SmartThreadPool 2.2.3 sets these to true and relies on the thread to check the
+                            // WorkItem cancellation status.  However, OpenSimulator uses a different mechanism to notify
+                            // scripts of co-operative termination and the abort code also relies on this method
+                            // returning false in order to implement a small wait.
+                            //
+                            // Therefore, as was the case previously with STP, we will not signal successful cancellation
+                            // here.  It's possible that OpenSimulator code could be changed in the future to remove
+                            // the need for this change.
+                            // **************************
                             success = false;
                             signalComplete = false;
                         }