IInterregionComms.cs 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  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 OpenMetaverse;
  28. using OpenSim.Framework;
  29. using OpenSim.Region.Framework.Scenes;
  30. namespace OpenSim.Region.Framework.Interfaces
  31. {
  32. public delegate bool ChildAgentUpdateReceived(AgentData data);
  33. public interface IInterregionCommsOut
  34. {
  35. #region Agents
  36. bool SendCreateChildAgent(ulong regionHandle, AgentCircuitData aCircuit, out string reason);
  37. /// <summary>
  38. /// Full child agent update.
  39. /// </summary>
  40. /// <param name="regionHandle"></param>
  41. /// <param name="data"></param>
  42. /// <returns></returns>
  43. bool SendChildAgentUpdate(ulong regionHandle, AgentData data);
  44. /// <summary>
  45. /// Short child agent update, mostly for position.
  46. /// </summary>
  47. /// <param name="regionHandle"></param>
  48. /// <param name="data"></param>
  49. /// <returns></returns>
  50. bool SendChildAgentUpdate(ulong regionHandle, AgentPosition data);
  51. bool SendRetrieveRootAgent(ulong regionHandle, UUID id, out IAgentData agent);
  52. /// <summary>
  53. /// Message from receiving region to departing region, telling it got contacted by the client.
  54. /// When sent over REST, it invokes the opaque uri.
  55. /// </summary>
  56. /// <param name="regionHandle"></param>
  57. /// <param name="id"></param>
  58. /// <param name="uri"></param>
  59. /// <returns></returns>
  60. bool SendReleaseAgent(ulong regionHandle, UUID id, string uri);
  61. /// <summary>
  62. /// Close agent.
  63. /// </summary>
  64. /// <param name="regionHandle"></param>
  65. /// <param name="id"></param>
  66. /// <returns></returns>
  67. bool SendCloseAgent(ulong regionHandle, UUID id);
  68. #endregion Agents
  69. #region Objects
  70. /// <summary>
  71. /// Create an object in the destination region. This message is used primarily for prim crossing.
  72. /// </summary>
  73. /// <param name="regionHandle"></param>
  74. /// <param name="sog"></param>
  75. /// <param name="isLocalCall"></param>
  76. /// <returns></returns>
  77. bool SendCreateObject(ulong regionHandle, SceneObjectGroup sog, bool isLocalCall);
  78. /// <summary>
  79. /// Create an object from the user's inventory in the destination region.
  80. /// This message is used primarily by clients.
  81. /// </summary>
  82. /// <param name="regionHandle"></param>
  83. /// <param name="userID"></param>
  84. /// <param name="itemID"></param>
  85. /// <returns></returns>
  86. bool SendCreateObject(ulong regionHandle, UUID userID, UUID itemID);
  87. #endregion Objects
  88. }
  89. // This may not be needed, but having it here for now.
  90. public interface IInterregionCommsIn
  91. {
  92. event ChildAgentUpdateReceived OnChildAgentUpdate;
  93. }
  94. }