refactor: rename ScriptInstance.m_CurrentResult to m_CurrentWorkItem to make it more understandable as to what it is and what it does (hold a thread pool work item for a waiting of in-progress event)

Also add other various illustrative comments
This commit is contained in:
Justin Clark-Casey (justincc)
2012-03-14 00:29:36 +00:00
parent 25592bbd85
commit 95ec96bf86
3 changed files with 50 additions and 25 deletions

View File

@@ -89,7 +89,7 @@ namespace OpenSim.Region.ScriptEngine.Interfaces
void Start();
/// <summary>
/// Stop the script.
/// Stop the script instance.
/// </summary>
/// <param name="timeout"></param>
/// <returns>true if the script was successfully stopped, false otherwise</returns>
@@ -97,13 +97,17 @@ namespace OpenSim.Region.ScriptEngine.Interfaces
void SetState(string state);
/// <summary>
/// Post an event to this script instance.
/// </summary>
/// <param name="data"></param>
void PostEvent(EventParams data);
void Suspend();
void Resume();
/// <summary>
/// Process the next event queued for this script
/// Process the next event queued for this script instance.
/// </summary>
/// <returns></returns>
object EventProcessor();