IInterRegionCommunications.cs 4.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  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 OpenSim 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.Collections.Generic;
  28. using OpenMetaverse;
  29. namespace OpenSim.Framework.Communications
  30. {
  31. public interface IInterRegionCommunications
  32. {
  33. string rdebugRegionName { get; set; }
  34. bool CheckRegion(string address, uint port);
  35. bool InformRegionOfChildAgent(ulong regionHandle, AgentCircuitData agentData);
  36. bool InformRegionOfPrimCrossing(ulong regionHandle, UUID primID, string objData, int XMLMethod);
  37. bool RegionUp(SerializableRegionInfo region, ulong regionhandle);
  38. bool ChildAgentUpdate(ulong regionHandle, ChildAgentDataUpdate cAgentData);
  39. bool ExpectAvatarCrossing(ulong regionHandle, UUID agentID, Vector3 position, bool isFlying);
  40. bool ExpectPrimCrossing(ulong regionHandle, UUID primID, Vector3 position, bool isFlying);
  41. bool AcknowledgeAgentCrossed(ulong regionHandle, UUID agentId);
  42. bool AcknowledgePrimCrossed(ulong regionHandle, UUID primID);
  43. bool TellRegionToCloseChildConnection(ulong regionHandle, UUID agentID);
  44. /// <summary>
  45. /// Try to inform friends in the given region about online status of agent.
  46. /// </summary>
  47. /// <param name="agentId">
  48. /// The <see cref="UUID"/> of the agent.
  49. /// </param>
  50. /// <param name="destRegionHandle">
  51. /// The regionHandle of the region.
  52. /// </param>
  53. /// <param name="friends">
  54. /// A List of <see cref="UUID"/>s of friends to inform in the given region.
  55. /// </param>
  56. /// <param name="online">
  57. /// Is the agent online or offline
  58. /// </param>
  59. /// <returns>
  60. /// A list of friends that couldn't be reached on this region.
  61. /// </returns>
  62. List<UUID> InformFriendsInOtherRegion(UUID agentId, ulong destRegionHandle, List<UUID> friends, bool online);
  63. /// <summary>
  64. /// Send TerminateFriend of exFriendID to agent agentID in region regionHandle.
  65. /// </summary>
  66. /// <param name="regionHandle">
  67. /// The handle of the region agentID is in (hopefully).
  68. /// </param>
  69. /// <param name="agentID">
  70. /// The agent to send the packet to.
  71. /// </param>
  72. /// <param name="exFriendID">
  73. /// The ex-friends ID.
  74. /// </param>
  75. /// <returns>
  76. /// Whether the packet could be sent. False if the agent couldn't be found in the region.
  77. /// </returns>
  78. bool TriggerTerminateFriend(ulong regionHandle, UUID agentID, UUID exFriendID);
  79. }
  80. }