IRegionArchiverModule.cs 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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.IO;
  28. namespace OpenSim.Region.Environment.Interfaces
  29. {
  30. /// <summary>
  31. /// Interface to region archive functionality
  32. /// </summary>
  33. public interface IRegionArchiverModule
  34. {
  35. /// <summary>
  36. /// Archive the region to the given path
  37. /// </summary>
  38. /// <param name="savePath"></param>
  39. void ArchiveRegion(string savePath);
  40. /// <summary>
  41. /// Archive the region to a stream.
  42. /// </summary>
  43. ///
  44. /// This may be a little problematic to use right now since saves happen asynchronously and there is not yet
  45. /// a mechanism to signal completion to the caller (possibly other than continually checking whether the
  46. /// stream has any data in it). TODO: Address this.
  47. ///
  48. /// <param name="saveStream"></param>
  49. void ArchiveRegion(Stream saveStream);
  50. /// <summary>
  51. /// Dearchive the given region archive into the scene
  52. /// </summary>
  53. /// <param name="loadPath"></param>
  54. void DearchiveRegion(string loadPath);
  55. /// <summary>
  56. /// Dearchive a region from a stream
  57. /// </summary>
  58. /// <param name="loadStream"></param>
  59. void DearchiveRegion(Stream loadStream);
  60. }
  61. }