1
0

IPresenceService.cs 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  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 System.Collections.Generic;
  30. using OpenMetaverse;
  31. namespace OpenSim.Services.Interfaces
  32. {
  33. public class PresenceInfo
  34. {
  35. public string UserID;
  36. public UUID RegionID;
  37. public PresenceInfo()
  38. {
  39. }
  40. public PresenceInfo(Dictionary<string, object> kvp)
  41. {
  42. if (kvp.ContainsKey("UserID"))
  43. UserID = kvp["UserID"].ToString();
  44. if (kvp.ContainsKey("RegionID"))
  45. UUID.TryParse(kvp["RegionID"].ToString(), out RegionID);
  46. }
  47. public Dictionary<string, object> ToKeyValuePairs()
  48. {
  49. Dictionary<string, object> result = new Dictionary<string, object>();
  50. result["UserID"] = UserID;
  51. result["RegionID"] = RegionID.ToString();
  52. return result;
  53. }
  54. }
  55. public interface IPresenceService
  56. {
  57. /// <summary>
  58. /// Store session information.
  59. /// </summary>
  60. /// <returns>/returns>
  61. /// <param name='userID'></param>
  62. /// <param name='sessionID'></param>
  63. /// <param name='secureSessionID'></param>
  64. bool LoginAgent(string userID, UUID sessionID, UUID secureSessionID);
  65. /// <summary>
  66. /// Remove session information.
  67. /// </summary>
  68. /// <returns></returns>
  69. /// <param name='sessionID'></param>
  70. bool LogoutAgent(UUID sessionID);
  71. /// <summary>
  72. /// Remove session information for all agents in the given region.
  73. /// </summary>
  74. /// <returns></returns>
  75. /// <param name='regionID'></param>
  76. bool LogoutRegionAgents(UUID regionID);
  77. /// <summary>
  78. /// Update data for an existing session.
  79. /// </summary>
  80. /// <returns></returns>
  81. /// <param name='sessionID'></param>
  82. /// <param name='regionID'></param>
  83. bool ReportAgent(UUID sessionID, UUID regionID);
  84. /// <summary>
  85. /// Get session information for a given session ID.
  86. /// </summary>
  87. /// <returns></returns>
  88. /// <param name='sessionID'></param>
  89. PresenceInfo GetAgent(UUID sessionID);
  90. /// <summary>
  91. /// Get session information for a collection of users.
  92. /// </summary>
  93. /// <returns>Session information for the users.</returns>
  94. /// <param name='userIDs'></param>
  95. PresenceInfo[] GetAgents(string[] userIDs);
  96. }
  97. }