IRegionArchiverModule.cs 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  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.IO;
  29. namespace OpenSim.Region.Framework.Interfaces
  30. {
  31. /// <summary>
  32. /// Interface to region archive functionality
  33. /// </summary>
  34. public interface IRegionArchiverModule
  35. {
  36. void HandleLoadOarConsoleCommand(string module, string[] cmdparams);
  37. void HandleSaveOarConsoleCommand(string module, string[] cmdparams);
  38. /// <summary>
  39. /// Archive the region to the given path
  40. /// </summary>
  41. ///
  42. /// This method occurs asynchronously. If you want notification of when it has completed then subscribe to
  43. /// the EventManager.OnOarFileSaved event.
  44. ///
  45. /// <param name="savePath"></param>
  46. void ArchiveRegion(string savePath);
  47. /// <summary>
  48. /// Archive the region to the given path
  49. /// </summary>
  50. ///
  51. /// This method occurs asynchronously. If you want notification of when it has completed then subscribe to
  52. /// the EventManager.OnOarFileSaved event.
  53. ///
  54. /// <param name="savePath"></param>
  55. /// <param name="requestId">If supplied, this request Id is later returned in the saved event</param>
  56. void ArchiveRegion(string savePath, Guid requestId);
  57. /// <summary>
  58. /// Archive the region to a stream.
  59. /// </summary>
  60. ///
  61. /// This method occurs asynchronously. If you want notification of when it has completed then subscribe to
  62. /// the EventManager.OnOarFileSaved event.
  63. ///
  64. /// <param name="saveStream"></param>
  65. /// <param name="requestId">If supplied, this request Id is later returned in the saved event</param>
  66. void ArchiveRegion(Stream saveStream, Guid requestId);
  67. /// <summary>
  68. /// Dearchive the given region archive. This replaces the existing scene.
  69. /// </summary>
  70. ///
  71. /// If you want notification of when it has completed then subscribe to the EventManager.OnOarFileLoaded event.
  72. ///
  73. /// <param name="loadPath"></param>
  74. void DearchiveRegion(string loadPath);
  75. /// <summary>
  76. /// Dearchive the given region archive. This replaces the existing scene.
  77. /// </summary>
  78. ///
  79. /// If you want notification of when it has completed then subscribe to the EventManager.OnOarFileLoaded event.
  80. ///
  81. /// <param name="loadPath"></param>
  82. /// <param name="merge">
  83. /// If true, the loaded region merges with the existing one rather than replacing it. Any terrain or region
  84. /// settings in the archive will be ignored.
  85. /// </param>
  86. /// <param name="skipAssets">
  87. /// If true, the archive is loaded without loading any assets contained within it. This is useful if the
  88. /// assets are already known to be present in the grid's asset service.
  89. /// </param>
  90. /// <param name="requestId">If supplied, this request Id is later returned in the saved event</param>
  91. void DearchiveRegion(string loadPath, bool merge, bool skipAssets, Guid requestId);
  92. /// <summary>
  93. /// Dearchive a region from a stream. This replaces the existing scene.
  94. /// </summary>
  95. ///
  96. /// If you want notification of when it has completed then subscribe to the EventManager.OnOarFileLoaded event.
  97. ///
  98. /// <param name="loadStream"></param>
  99. void DearchiveRegion(Stream loadStream);
  100. /// <summary>
  101. /// Dearchive a region from a stream. This replaces the existing scene.
  102. /// </summary>
  103. ///
  104. /// If you want notification of when it has completed then subscribe to the EventManager.OnOarFileLoaded event.
  105. ///
  106. /// <param name="loadStream"></param>
  107. /// <param name="merge">
  108. /// If true, the loaded region merges with the existing one rather than replacing it. Any terrain or region
  109. /// settings in the archive will be ignored.
  110. /// </param>
  111. /// <param name="skipAssets">
  112. /// If true, the archive is loaded without loading any assets contained within it. This is useful if the
  113. /// assets are already known to be present in the grid's asset service.
  114. /// </param
  115. /// <param name="requestId">If supplied, this request Id is later returned in the saved event</param>
  116. void DearchiveRegion(Stream loadStream, bool merge, bool skipAssets, Guid requestId);
  117. }
  118. }