ISimulationService.cs 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  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 OpenSim.Framework;
  29. using OpenMetaverse;
  30. using GridRegion = OpenSim.Services.Interfaces.GridRegion;
  31. namespace OpenSim.Services.Interfaces
  32. {
  33. public interface ISimulationService
  34. {
  35. IScene GetScene(ulong regionHandle);
  36. ISimulationService GetInnerService();
  37. #region Agents
  38. /// <summary>
  39. /// Ask the simulator hosting the destination to create an agent on that region.
  40. /// </summary>
  41. /// <param name="destination"></param>
  42. /// <param name="aCircuit"></param>
  43. /// <param name="flags"></param>
  44. /// <param name="reason">Reason message in the event of a failure.</param>
  45. bool CreateAgent(GridRegion destination, AgentCircuitData aCircuit, uint flags, out string reason);
  46. /// <summary>
  47. /// Full child agent update.
  48. /// </summary>
  49. /// <param name="regionHandle"></param>
  50. /// <param name="data"></param>
  51. /// <returns></returns>
  52. bool UpdateAgent(GridRegion destination, AgentData data);
  53. /// <summary>
  54. /// Short child agent update, mostly for position.
  55. /// </summary>
  56. /// <param name="regionHandle"></param>
  57. /// <param name="data"></param>
  58. /// <returns></returns>
  59. bool UpdateAgent(GridRegion destination, AgentPosition data);
  60. bool RetrieveAgent(GridRegion destination, UUID id, out IAgentData agent);
  61. bool QueryAccess(GridRegion destination, UUID id, Vector3 position, out string version, out string reason);
  62. /// <summary>
  63. /// Message from receiving region to departing region, telling it got contacted by the client.
  64. /// When sent over REST, it invokes the opaque uri.
  65. /// </summary>
  66. /// <param name="regionHandle"></param>
  67. /// <param name="id"></param>
  68. /// <param name="uri"></param>
  69. /// <returns></returns>
  70. bool ReleaseAgent(UUID originRegion, UUID id, string uri);
  71. /// <summary>
  72. /// Close agent.
  73. /// </summary>
  74. /// <param name="regionHandle"></param>
  75. /// <param name="id"></param>
  76. /// <returns></returns>
  77. bool CloseAgent(GridRegion destination, UUID id);
  78. #endregion Agents
  79. #region Objects
  80. /// <summary>
  81. /// Create an object in the destination region. This message is used primarily for prim crossing.
  82. /// </summary>
  83. /// <param name="regionHandle"></param>
  84. /// <param name="sog"></param>
  85. /// <param name="isLocalCall"></param>
  86. /// <returns></returns>
  87. bool CreateObject(GridRegion destination, ISceneObject sog, bool isLocalCall);
  88. /// <summary>
  89. /// Create an object from the user's inventory in the destination region.
  90. /// This message is used primarily by clients.
  91. /// </summary>
  92. /// <param name="regionHandle"></param>
  93. /// <param name="userID"></param>
  94. /// <param name="itemID"></param>
  95. /// <returns></returns>
  96. bool CreateObject(GridRegion destination, UUID userID, UUID itemID);
  97. #endregion Objects
  98. }
  99. }