clockwerk-opensim-stable – Blame information for rev 1

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