1
0

IScriptModule.cs 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSimulator Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using System;
  28. using System.Collections;
  29. using System.Collections.Generic;
  30. using OpenMetaverse;
  31. namespace OpenSim.Region.Framework.Interfaces
  32. {
  33. public delegate void ScriptRemoved(UUID script);
  34. public delegate void ObjectRemoved(UUID prim);
  35. public interface IScriptModule: INonSharedRegionModule
  36. {
  37. /// <summary>
  38. /// Triggered when a script is removed from the script module.
  39. /// </summary>
  40. event ScriptRemoved OnScriptRemoved;
  41. /// <summary>
  42. /// Triggered when an object is removed via the script module.
  43. /// </summary>
  44. event ObjectRemoved OnObjectRemoved;
  45. string ScriptEngineName { get; }
  46. string GetXMLState(UUID itemID);
  47. bool SetXMLState(UUID itemID, string xml);
  48. /// <summary>
  49. /// Post a script event to a single script.
  50. /// </summary>
  51. /// <returns>true if the post suceeded, false if it did not</returns>
  52. /// <param name='itemID'>The item ID of the script.</param>
  53. /// <param name='name'>The name of the event.</param>
  54. /// <param name='args'>
  55. /// The arguments of the event. These are in the order in which they appear.
  56. /// e.g. for http_request this will be an object array of key request_id, string method, string body
  57. /// </param>
  58. bool PostScriptEvent(UUID itemID, string name, Object[] args);
  59. bool PostObjectEvent(UUID itemID, string name, Object[] args);
  60. /// <summary>
  61. /// Suspends a script.
  62. /// </summary>
  63. /// <param name="itemID">The item ID of the script.</param>
  64. void SuspendScript(UUID itemID);
  65. /// <summary>
  66. /// Resumes a script.
  67. /// </summary>
  68. /// <param name="itemID">The item ID of the script.</param>
  69. void ResumeScript(UUID itemID);
  70. ArrayList GetScriptErrors(UUID itemID);
  71. bool HasScript(UUID itemID, out bool running);
  72. /// <summary>
  73. /// Returns true if a script is running.
  74. /// </summary>
  75. /// <param name="itemID">The item ID of the script.</param>
  76. bool GetScriptState(UUID itemID);
  77. void SaveAllState();
  78. /// <summary>
  79. /// Starts the processing threads.
  80. /// </summary>
  81. void StartProcessing();
  82. /// <summary>
  83. /// Get the execution times of all scripts in the given array if they are currently running.
  84. /// </summary>
  85. /// <returns>
  86. /// A float the value is a representative execution time in milliseconds of all scripts in that Array.
  87. /// </returns>
  88. float GetScriptExecutionTime(List<UUID> itemIDs);
  89. /// <summary>
  90. /// Get the execution times of all scripts in each object.
  91. /// </summary>
  92. /// <returns>
  93. /// A dictionary where the key is the root object ID of a linkset
  94. /// and the value is a representative execution time in milliseconds of all scripts in that linkset.
  95. /// </returns>
  96. Dictionary<uint, float> GetObjectScriptsExecutionTimes();
  97. }
  98. }