1
0

IRegionArchiverModule.cs 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  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 System.Collections.Generic;
  29. using System.IO;
  30. using OpenMetaverse;
  31. namespace OpenSim.Region.Framework.Interfaces
  32. {
  33. /// <summary>
  34. /// Interface to region archive functionality
  35. /// </summary>
  36. public interface IRegionArchiverModule
  37. {
  38. void HandleLoadOarConsoleCommand(string module, string[] cmdparams);
  39. void HandleSaveOarConsoleCommand(string module, string[] cmdparams);
  40. /// <summary>
  41. /// Archive the region to the given path
  42. /// </summary>
  43. ///
  44. /// This method occurs asynchronously. If you want notification of when it has completed then subscribe to
  45. /// the EventManager.OnOarFileSaved event.
  46. ///
  47. /// <param name="savePath"></param>
  48. void ArchiveRegion(string savePath, Dictionary<string, object> options);
  49. /// <summary>
  50. /// Archive the region to the given path
  51. /// </summary>
  52. /// <remarks>
  53. /// This method occurs asynchronously. If you want notification of when it has completed then subscribe to
  54. /// the EventManager.OnOarFileSaved event.
  55. /// </remarks>
  56. /// <param name="savePath"></param>
  57. /// <param name="requestId">If supplied, this request Id is later returned in the saved event</param>
  58. /// <param name="options">Options for the save</param>
  59. void ArchiveRegion(string savePath, Guid requestId, Dictionary<string, object> options);
  60. /// <summary>
  61. /// Archive the region to a stream.
  62. /// </summary>
  63. /// <remarks>
  64. /// This method occurs asynchronously. If you want notification of when it has completed then subscribe to
  65. /// the EventManager.OnOarFileSaved event.
  66. /// </remarks>
  67. /// <param name="saveStream"></param>
  68. /// <param name="requestId">If supplied, this request Id is later returned in the saved event</param>
  69. void ArchiveRegion(Stream saveStream, Guid requestId);
  70. /// <summary>
  71. /// Archive the region to a stream.
  72. /// </summary>
  73. /// <remarks>
  74. /// This method occurs asynchronously. If you want notification of when it has completed then subscribe to
  75. /// the EventManager.OnOarFileSaved event.
  76. /// </remarks>
  77. /// <param name="saveStream"></param>
  78. /// <param name="requestId">If supplied, this request Id is later returned in the saved event</param>
  79. /// <param name="options">Options for the save</param>
  80. void ArchiveRegion(Stream saveStream, Guid requestId, Dictionary<string, object> options);
  81. /// <summary>
  82. /// Dearchive the given region archive. This replaces the existing scene.
  83. /// </summary>
  84. /// <remarks>
  85. /// If you want notification of when it has completed then subscribe to the EventManager.OnOarFileLoaded event.
  86. /// </remarks>
  87. /// <param name="loadPath"></param>
  88. void DearchiveRegion(string loadPath);
  89. /// <summary>
  90. /// Dearchive the given region archive. This replaces the existing scene.
  91. /// </summary>
  92. ///
  93. /// If you want notification of when it has completed then subscribe to the EventManager.OnOarFileLoaded event.
  94. ///
  95. /// <param name="loadPath"></param>
  96. /// <param name="requestId">If supplied, this request Id is later returned in the saved event</param>
  97. /// <param name="options">
  98. /// Dictionary of options.
  99. /// </param>
  100. void DearchiveRegion(string loadPath, Guid requestId, Dictionary<string,object> options);
  101. /// <summary>
  102. /// Dearchive a region from a stream. This replaces the existing scene.
  103. /// </summary>
  104. ///
  105. /// If you want notification of when it has completed then subscribe to the EventManager.OnOarFileLoaded event.
  106. ///
  107. /// <param name="loadStream"></param>
  108. void DearchiveRegion(Stream loadStream);
  109. /// <summary>
  110. /// Dearchive a region from a stream. This replaces the existing scene.
  111. /// </summary>
  112. ///
  113. /// If you want notification of when it has completed then subscribe to the EventManager.OnOarFileLoaded event.
  114. ///
  115. /// <param name="loadStream"></param>
  116. /// <param name="requestId">If supplied, this request Id is later returned in the saved event</param>
  117. /// <param name="options">
  118. /// Dictionary of options.
  119. /// </param>
  120. void DearchiveRegion(Stream loadStream, Guid requestId, Dictionary<string,object> options);
  121. }
  122. }