ICapabilitiesModule.cs 3.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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.Collections.Generic;
  28. using OpenMetaverse;
  29. using OpenSim.Framework;
  30. using Caps=OpenSim.Framework.Capabilities.Caps;
  31. namespace OpenSim.Region.Framework.Interfaces
  32. {
  33. public interface ICapabilitiesModule
  34. {
  35. void NewUserConnection(AgentCircuitData agent);
  36. /// <summary>
  37. /// Add a caps handler for the given agent. If the CAPS handler already exists for this agent,
  38. /// then it is replaced by a new CAPS handler.
  39. ///
  40. /// FIXME: On login this is called twice, once for the login and once when the connection is made.
  41. /// This is somewhat innefficient and should be fixed. The initial login creation is necessary
  42. /// since the client asks for capabilities immediately after being informed of the seed.
  43. /// </summary>
  44. /// <param name="agentId"></param>
  45. /// <param name="capsObjectPath"></param>
  46. void AddCapsHandler(UUID agentId);
  47. /// <summary>
  48. /// Remove the caps handler for a given agent.
  49. /// </summary>
  50. /// <param name="agentId"></param>
  51. void RemoveCapsHandler(UUID agentId);
  52. /// <summary>
  53. /// Will return null if the agent doesn't have a caps handler registered
  54. /// </summary>
  55. /// <param name="agentId"></param>
  56. Caps GetCapsHandlerForUser(UUID agentId);
  57. Dictionary<ulong, string> GetChildrenSeeds(UUID agentID);
  58. string GetChildSeed(UUID agentID, ulong handle);
  59. void SetChildrenSeed(UUID agentID, Dictionary<ulong, string> seeds);
  60. void DropChildSeed(UUID agentID, ulong handle);
  61. string GetCapsPath(UUID agentId);
  62. }
  63. }