opensim-development – Blame information for rev 1

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