Refactor IScriptInstance / IScriptEngine to use a generic IScriptWorkItem,

which is a thin wrapper around a IWorkItemResult from the SmartThreadPool.
However, it is very easy to reimplement on top of basic threading and therefore
makes the IScriptInstance class independent of the specific threading
implementation.

5 files changed, 79 insertions, 7 deletions

diff --git a/OpenSim/Region/ScriptEngine/Interfaces/IScriptEngine.cs b/OpenSim/Region/ScriptEngine/Interfaces/IScriptEngine.cs
index 7c22eed..6b3804c 100644
--- a/OpenSim/Region/ScriptEngine/Interfaces/IScriptEngine.cs
+++ b/OpenSim/Region/ScriptEngine/Interfaces/IScriptEngine.cs
@@ -57,7 +57,7 @@ namespace OpenSim.Region.ScriptEngine.Interfaces
         bool GetScriptState(LLUUID itemID);
         void SetState(LLUUID itemID, string newState);
         int GetStartParameter(LLUUID itemID);
-        IWorkItemResult QueueEventHandler(object parms);
+        IScriptWorkItem QueueEventHandler(object parms);
 
         DetectParams GetDetectParams(LLUUID item, int number);
     }
diff --git a/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs b/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs
index 03a3802..3aeb602 100644
--- a/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs
+++ b/OpenSim/Region/ScriptEngine/Interfaces/IScriptInstance.cs
@@ -43,6 +43,13 @@ namespace OpenSim.Region.ScriptEngine.Interfaces
         AttachmentCrossing = 2
     }
 
+    public interface IScriptWorkItem
+    {
+        bool Cancel();
+        void Abort();
+        bool Wait(TimeSpan t);
+    }
+
     public interface IScriptInstance
     {
         bool Running { get; set; }
diff --git a/OpenSim/Region/ScriptEngine/Shared/Instance/ScriptInstance.cs b/OpenSim/Region/ScriptEngine/Shared/Instance/ScriptInstance.cs
index ff50396..8ce1413 100644
--- a/OpenSim/Region/ScriptEngine/Shared/Instance/ScriptInstance.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/Instance/ScriptInstance.cs
@@ -53,7 +53,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Instance
     public class ScriptInstance : IScriptInstance
     {
         private IScriptEngine m_Engine;
-        private IWorkItemResult m_CurrentResult=null;
+        private IScriptWorkItem m_CurrentResult=null;
         private Queue m_EventQueue = new Queue(32);
         private bool m_RunEvents = false;
         private LLUUID m_ItemID;
@@ -346,7 +346,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Instance
 
         public bool Stop(int timeout)
         {
-            IWorkItemResult result;
+            IScriptWorkItem result;
 
             lock (m_EventQueue)
             {
@@ -370,7 +370,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Instance
                 m_RunEvents = false;
             }
 
-            if (SmartThreadPool.WaitAll(new IWorkItemResult[] {result}, new TimeSpan((long)timeout * 100000), false))
+            if (result.Wait(new TimeSpan((long)timeout * 100000)))
             {
                 return true;
             }
diff --git a/OpenSim/Region/ScriptEngine/XEngine/XEngine.cs b/OpenSim/Region/ScriptEngine/XEngine/XEngine.cs
index 8fd8a1c..a33554c 100644
--- a/OpenSim/Region/ScriptEngine/XEngine/XEngine.cs
+++ b/OpenSim/Region/ScriptEngine/XEngine/XEngine.cs
@@ -655,10 +655,10 @@ namespace OpenSim.Region.ScriptEngine.XEngine
         //
         // Used by script instances to queue event handler jobs
         //
-        public IWorkItemResult QueueEventHandler(object parms)
+        public IScriptWorkItem QueueEventHandler(object parms)
         {
-            return m_ThreadPool.QueueWorkItem(new WorkItemCallback(
-                                                  this.ProcessEventHandler), parms);
+            return new XWorkItem(m_ThreadPool.QueueWorkItem(new WorkItemCallback(
+                                                  this.ProcessEventHandler), parms));
         }
 
         //
diff --git a/OpenSim/Region/ScriptEngine/XEngine/XWorkItem.cs b/OpenSim/Region/ScriptEngine/XEngine/XWorkItem.cs
new file mode 100644
index 0000000..4686d82
--- /dev/null
+++ b/OpenSim/Region/ScriptEngine/XEngine/XWorkItem.cs
@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) Contributors, http://opensimulator.org/
+ * See CONTRIBUTORS.TXT for a full list of copyright holders.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of the OpenSim Project nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+using System;
+using System.IO;
+using System.Threading;
+using Amib.Threading;
+using OpenSim.Region.ScriptEngine.Interfaces;
+
+namespace OpenSim.Region.ScriptEngine.XEngine
+{
+    public class XWorkItem : IScriptWorkItem
+    {
+        private IWorkItemResult wr;
+
+        public IWorkItemResult WorkItem
+        {
+            get { return wr; }
+        }
+
+        public XWorkItem(IWorkItemResult w)
+        {
+            wr = w;
+        }
+
+        public bool Cancel()
+        {
+            return wr.Cancel();
+        }
+
+        public void Abort()
+        {
+            wr.Abort();
+        }
+
+        public bool Wait(TimeSpan t)
+        {
+            return SmartThreadPool.WaitAll(new IWorkItemResult[] {wr}, t, false);
+        }
+    }
+}