ISimulationService.cs 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  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.Generic;
  29. using OpenSim.Framework;
  30. using OpenMetaverse;
  31. using GridRegion = OpenSim.Services.Interfaces.GridRegion;
  32. namespace OpenSim.Services.Interfaces
  33. {
  34. public interface ISimulationService
  35. {
  36. /// <summary>
  37. /// Retrieve the scene with the given region ID.
  38. /// </summary>
  39. /// <param name='regionId'>
  40. /// Region identifier.
  41. /// </param>
  42. /// <returns>
  43. /// The scene.
  44. /// </returns>
  45. IScene GetScene(UUID regionId);
  46. ISimulationService GetInnerService();
  47. #region Agents
  48. /// <summary>
  49. /// Ask the simulator hosting the destination to create an agent on that region.
  50. /// </summary>
  51. /// <param name="source">The region that the user is coming from. Will be null if the user
  52. /// logged-in directly, or arrived from a simulator that doesn't send this parameter.</param>
  53. /// <param name="destination"></param>
  54. /// <param name="aCircuit"></param>
  55. /// <param name="flags"></param>
  56. /// <param name="reason">Reason message in the event of a failure.</param>
  57. bool CreateAgent(GridRegion source, GridRegion destination, AgentCircuitData aCircuit, uint flags, out string reason);
  58. /// <summary>
  59. /// Full child agent update.
  60. /// </summary>
  61. /// <param name="regionHandle"></param>
  62. /// <param name="data"></param>
  63. /// <returns></returns>
  64. bool UpdateAgent(GridRegion destination, AgentData data);
  65. /// <summary>
  66. /// Short child agent update, mostly for position.
  67. /// </summary>
  68. /// <param name="regionHandle"></param>
  69. /// <param name="data"></param>
  70. /// <returns></returns>
  71. bool UpdateAgent(GridRegion destination, AgentPosition data);
  72. /// <summary>
  73. /// Returns whether a propspective user is allowed to visit the region.
  74. /// </summary>
  75. /// <param name="destination">Desired destination</param>
  76. /// <param name="agentID">The visitor's User ID</param>
  77. /// <param name="agentHomeURI">The visitor's Home URI. Will be missing (null) in older OpenSims.</param>
  78. /// <param name="viaTeleport">True: via teleport; False: via cross (walking)</param>
  79. /// <param name="position">Position in the region</param>
  80. /// <param name="sversion">
  81. /// Version that the requesting simulator is runing. If null then no version check is carried out.
  82. /// </param>
  83. /// <param name="version">Version that the target simulator is running</param>
  84. /// <param name="reason">[out] Optional error message</param>
  85. /// <returns>True: ok; False: not allowed</returns>
  86. bool QueryAccess(GridRegion destination, UUID agentID, string agentHomeURI, bool viaTeleport, Vector3 position, string sversion, List<UUID> features, out string version, out string reason);
  87. /// <summary>
  88. /// Message from receiving region to departing region, telling it got contacted by the client.
  89. /// When sent over REST, it invokes the opaque uri.
  90. /// </summary>
  91. /// <param name="regionHandle"></param>
  92. /// <param name="id"></param>
  93. /// <param name="uri"></param>
  94. /// <returns></returns>
  95. bool ReleaseAgent(UUID originRegion, UUID id, string uri);
  96. /// <summary>
  97. /// Close agent.
  98. /// </summary>
  99. /// <param name="regionHandle"></param>
  100. /// <param name="id"></param>
  101. /// <returns></returns>
  102. bool CloseAgent(GridRegion destination, UUID id, string auth_token);
  103. #endregion Agents
  104. #region Objects
  105. /// <summary>
  106. /// Create an object in the destination region. This message is used primarily for prim crossing.
  107. /// </summary>
  108. /// <param name="regionHandle"></param>
  109. /// <param name="sog"></param>
  110. /// <param name="isLocalCall"></param>
  111. /// <returns></returns>
  112. bool CreateObject(GridRegion destination, Vector3 newPosition, ISceneObject sog, bool isLocalCall);
  113. #endregion Objects
  114. }
  115. }