aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/OptionalModules/Scripting/Minimodule/Interfaces/IScheduler.cs
diff options
context:
space:
mode:
Diffstat (limited to 'OpenSim/Region/OptionalModules/Scripting/Minimodule/Interfaces/IScheduler.cs')
-rw-r--r--OpenSim/Region/OptionalModules/Scripting/Minimodule/Interfaces/IScheduler.cs86
1 files changed, 43 insertions, 43 deletions
diff --git a/OpenSim/Region/OptionalModules/Scripting/Minimodule/Interfaces/IScheduler.cs b/OpenSim/Region/OptionalModules/Scripting/Minimodule/Interfaces/IScheduler.cs
index cf45de7..0be8473 100644
--- a/OpenSim/Region/OptionalModules/Scripting/Minimodule/Interfaces/IScheduler.cs
+++ b/OpenSim/Region/OptionalModules/Scripting/Minimodule/Interfaces/IScheduler.cs
@@ -1,43 +1,43 @@
1using System; 1using System;
2 2
3namespace OpenSim.Region.OptionalModules.Scripting.Minimodule 3namespace OpenSim.Region.OptionalModules.Scripting.Minimodule
4{ 4{
5 interface IScheduler 5 interface IScheduler
6 { 6 {
7 /// <summary> 7 /// <summary>
8 /// Schedule an event callback to occur 8 /// Schedule an event callback to occur
9 /// when 'time' is elapsed. 9 /// when 'time' is elapsed.
10 /// </summary> 10 /// </summary>
11 /// <param name="time">The period to wait before executing</param> 11 /// <param name="time">The period to wait before executing</param>
12 void RunIn(TimeSpan time); 12 void RunIn(TimeSpan time);
13 13
14 /// <summary> 14 /// <summary>
15 /// Schedule an event callback to fire 15 /// Schedule an event callback to fire
16 /// every "time". Equivilent to a repeating 16 /// every "time". Equivilent to a repeating
17 /// timer. 17 /// timer.
18 /// </summary> 18 /// </summary>
19 /// <param name="time">The period to wait between executions</param> 19 /// <param name="time">The period to wait between executions</param>
20 void RunAndRepeat(TimeSpan time); 20 void RunAndRepeat(TimeSpan time);
21 21
22 /// <summary> 22 /// <summary>
23 /// Fire this scheduler only when the region has 23 /// Fire this scheduler only when the region has
24 /// a user in it. 24 /// a user in it.
25 /// </summary> 25 /// </summary>
26 bool WhenRegionOccupied { get; set; } 26 bool WhenRegionOccupied { get; set; }
27 27
28 /// <summary> 28 /// <summary>
29 /// Fire this event only when the region is visible 29 /// Fire this event only when the region is visible
30 /// to a child agent, or there is a full agent 30 /// to a child agent, or there is a full agent
31 /// in this region. 31 /// in this region.
32 /// </summary> 32 /// </summary>
33 bool WhenRegionVisible { get; set; } 33 bool WhenRegionVisible { get; set; }
34 34
35 /// <summary> 35 /// <summary>
36 /// Determines whether this runs in the master scheduler thread, or a new thread 36 /// Determines whether this runs in the master scheduler thread, or a new thread
37 /// is spawned to handle your request. Running in scheduler may mean that your 37 /// is spawned to handle your request. Running in scheduler may mean that your
38 /// code does not execute perfectly on time, however will result in a lower 38 /// code does not execute perfectly on time, however will result in a lower
39 /// processor cost to running your code. 39 /// processor cost to running your code.
40 /// </summary> 40 /// </summary>
41 bool Schedule { get; set; } 41 bool Schedule { get; set; }
42 } 42 }
43} 43}