1
0

IScheduler.cs 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  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. namespace OpenSim.Region.OptionalModules.Scripting.Minimodule
  29. {
  30. interface IScheduler
  31. {
  32. /// <summary>
  33. /// Schedule an event callback to occur
  34. /// when 'time' is elapsed.
  35. /// </summary>
  36. /// <param name="time">The period to wait before executing</param>
  37. void RunIn(TimeSpan time);
  38. /// <summary>
  39. /// Schedule an event callback to fire
  40. /// every "time". Equivilent to a repeating
  41. /// timer.
  42. /// </summary>
  43. /// <param name="time">The period to wait between executions</param>
  44. void RunAndRepeat(TimeSpan time);
  45. /// <summary>
  46. /// Fire this scheduler only when the region has
  47. /// a user in it.
  48. /// </summary>
  49. bool IfOccupied { get; set; }
  50. /// <summary>
  51. /// Fire this only when simulator performance
  52. /// is reasonable. (eg sysload <= 1.0)
  53. /// </summary>
  54. bool IfHealthy { get; set; }
  55. /// <summary>
  56. /// Fire this event only when the region is visible
  57. /// to a child agent, or there is a full agent
  58. /// in this region.
  59. /// </summary>
  60. bool IfVisible { get; set; }
  61. /// <summary>
  62. /// Determines whether this runs in the master scheduler thread, or a new thread
  63. /// is spawned to handle your request. Running in scheduler may mean that your
  64. /// code does not execute perfectly on time, however will result in better
  65. /// region performance.
  66. /// </summary>
  67. /// <remarks>
  68. /// Default: true
  69. /// </remarks>
  70. bool Schedule { get; set; }
  71. }
  72. }