opensim-development – Blame information for rev 1

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