1
0

IScriptModule.cs 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  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 class ScriptTopStatsData
  36. {
  37. public uint localID;
  38. public float time;
  39. public int memory;
  40. };
  41. public interface IScriptModule: INonSharedRegionModule
  42. {
  43. /// <summary>
  44. /// Triggered when a script is removed from the script module.
  45. /// </summary>
  46. event ScriptRemoved OnScriptRemoved;
  47. /// <summary>
  48. /// Triggered when an object is removed via the script module.
  49. /// </summary>
  50. event ObjectRemoved OnObjectRemoved;
  51. string ScriptEngineName { get; }
  52. string GetXMLState(UUID itemID);
  53. bool SetXMLState(UUID itemID, string xml);
  54. /// <summary>
  55. /// Post a script event to a single script.
  56. /// </summary>
  57. /// <returns>true if the post suceeded, false if it did not</returns>
  58. /// <param name='itemID'>The item ID of the script.</param>
  59. /// <param name='name'>The name of the event.</param>
  60. /// <param name='args'>
  61. /// The arguments of the event. These are in the order in which they appear.
  62. /// e.g. for http_request this will be an object array of key request_id, string method, string body
  63. /// </param>
  64. bool PostScriptEvent(UUID itemID, string name, Object[] args);
  65. bool PostObjectEvent(UUID itemID, string name, Object[] args);
  66. /// <summary>
  67. /// Suspends a script.
  68. /// </summary>
  69. /// <param name="itemID">The item ID of the script.</param>
  70. bool SuspendScript(UUID itemID);
  71. /// <summary>
  72. /// Resumes a script.
  73. /// </summary>
  74. /// <param name="itemID">The item ID of the script.</param>
  75. bool ResumeScript(UUID itemID);
  76. ArrayList GetScriptErrors(UUID itemID);
  77. bool HasScript(UUID itemID, out bool running);
  78. /// <summary>
  79. /// Returns true if a script is running.
  80. /// </summary>
  81. /// <param name="itemID">The item ID of the script.</param>
  82. bool GetScriptState(UUID itemID);
  83. void SaveAllState();
  84. /// <summary>
  85. /// Starts the processing threads.
  86. /// </summary>
  87. void StartProcessing();
  88. /// <summary>
  89. /// Get the execution times of all scripts in the given array if they are currently running.
  90. /// </summary>
  91. /// <returns>
  92. /// A float the value is a representative execution time in milliseconds of all scripts in that Array.
  93. /// </returns>
  94. float GetScriptExecutionTime(List<UUID> itemIDs);
  95. int GetScriptsMemory(List<UUID> itemIDs);
  96. /// <summary>
  97. /// Get the execution times of all scripts in each object.
  98. /// </summary>
  99. /// <returns>
  100. /// A dictionary where the key is the root object ID of a linkset
  101. /// and the value is a representative execution time in milliseconds of all scripts in that linkset.
  102. /// </returns>
  103. Dictionary<uint, float> GetObjectScriptsExecutionTimes();
  104. /// <summary>
  105. /// Get the used memory and exec time of all scripts in each object.
  106. /// if time or memory is higher than min values;
  107. /// </summary>
  108. /// <returns>
  109. /// A dictionary where the key is the root object ID of a linkset
  110. /// and the value is a class with amount of bytes being used by the script
  111. /// </returns>
  112. ICollection<ScriptTopStatsData> GetTopObjectStats(float mintime, int minmemory, out float totaltime, out float totalmemory);
  113. }
  114. }