aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/Framework/Interfaces/IInventoryArchiverModule.cs
diff options
context:
space:
mode:
authorAliciaRaven2014-09-06 20:23:40 +0100
committerJustin Clark-Casey (justincc)2014-09-23 00:04:53 +0100
commit5bc3bbbcf3e7df23db3e3e0410266ba72a1a1e14 (patch)
tree810e7e39cb5dfa5ee77f40f3c1ae3eae2a9175fd /OpenSim/Region/Framework/Interfaces/IInventoryArchiverModule.cs
parentChange existing IAR save to use UUID for its callback reference instead of Gu... (diff)
downloadopensim-SC-5bc3bbbcf3e7df23db3e3e0410266ba72a1a1e14.zip
opensim-SC-5bc3bbbcf3e7df23db3e3e0410266ba72a1a1e14.tar.gz
opensim-SC-5bc3bbbcf3e7df23db3e3e0410266ba72a1a1e14.tar.bz2
opensim-SC-5bc3bbbcf3e7df23db3e3e0410266ba72a1a1e14.tar.xz
Add an event callback for loading IAR files. The callback for creating them already existed but not for loading. This is of interest for use by region modules. Also includes reporting numbers of items saved and items filtered to the completed log printout.
Diffstat (limited to 'OpenSim/Region/Framework/Interfaces/IInventoryArchiverModule.cs')
-rw-r--r--OpenSim/Region/Framework/Interfaces/IInventoryArchiverModule.cs27
1 files changed, 24 insertions, 3 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/IInventoryArchiverModule.cs b/OpenSim/Region/Framework/Interfaces/IInventoryArchiverModule.cs
index 54251a4..0795589 100644
--- a/OpenSim/Region/Framework/Interfaces/IInventoryArchiverModule.cs
+++ b/OpenSim/Region/Framework/Interfaces/IInventoryArchiverModule.cs
@@ -42,8 +42,24 @@ namespace OpenSim.Region.Framework.Interfaces
42 /// <param name="invPath">The inventory path saved</param> 42 /// <param name="invPath">The inventory path saved</param>
43 /// <param name="savePath">The stream to which the archive was saved</param> 43 /// <param name="savePath">The stream to which the archive was saved</param>
44 /// <param name="reportedException">Contains the exception generated if the save did not succeed</param> 44 /// <param name="reportedException">Contains the exception generated if the save did not succeed</param>
45 /// <param name="SaveCount">Number of inventory items saved to archive</param>
46 /// <param name="FilterCount">Number of inventory items skipped due to perm filter option</param>
45 public delegate void InventoryArchiveSaved( 47 public delegate void InventoryArchiveSaved(
46 UUID id, bool succeeded, UserAccount userInfo, string invPath, Stream saveStream, Exception reportedException); 48 UUID id, bool succeeded, UserAccount userInfo, string invPath, Stream saveStream, Exception reportedException, int SaveCount, int FilterCount);
49
50 /// <summary>
51 /// Used for the OnInventoryArchiveLoaded event.
52 /// </summary>
53 /// <param name="id">Request id</param>
54 /// <param name="succeeded">true if the load succeeded, false otherwise</param>
55 /// <param name="userInfo">The user for whom the load was conducted</param>
56 /// <param name="invPath">The inventory path loaded</param>
57 /// <param name="savePath">The stream from which the archive was loaded</param>
58 /// <param name="reportedException">Contains the exception generated if the load did not succeed</param>
59 /// <param name="LoadCount">Number of inventory items loaded from archive</param>
60 public delegate void InventoryArchiveLoaded(
61 UUID id, bool succeeded, UserAccount userInfo, string invPath, Stream loadStream, Exception reportedException, int LoadCount);
62
47 63
48 public interface IInventoryArchiverModule 64 public interface IInventoryArchiverModule
49 { 65 {
@@ -53,6 +69,11 @@ namespace OpenSim.Region.Framework.Interfaces
53 event InventoryArchiveSaved OnInventoryArchiveSaved; 69 event InventoryArchiveSaved OnInventoryArchiveSaved;
54 70
55 /// <summary> 71 /// <summary>
72 /// Fired when an archive inventory load has been completed.
73 /// </summary>
74 event InventoryArchiveLoaded OnInventoryArchiveLoaded;
75
76 /// <summary>
56 /// Dearchive a user's inventory folder from the given stream 77 /// Dearchive a user's inventory folder from the given stream
57 /// </summary> 78 /// </summary>
58 /// <param name="firstName"></param> 79 /// <param name="firstName"></param>
@@ -60,7 +81,7 @@ namespace OpenSim.Region.Framework.Interfaces
60 /// <param name="invPath">The inventory path in which to place the loaded folders and items</param> 81 /// <param name="invPath">The inventory path in which to place the loaded folders and items</param>
61 /// <param name="loadStream">The stream from which the inventory archive will be loaded</param> 82 /// <param name="loadStream">The stream from which the inventory archive will be loaded</param>
62 /// <returns>true if the first stage of the operation succeeded, false otherwise</returns> 83 /// <returns>true if the first stage of the operation succeeded, false otherwise</returns>
63 bool DearchiveInventory(string firstName, string lastName, string invPath, string pass, Stream loadStream); 84 bool DearchiveInventory(UUID id, string firstName, string lastName, string invPath, string pass, Stream loadStream);
64 85
65 /// <summary> 86 /// <summary>
66 /// Dearchive a user's inventory folder from the given stream 87 /// Dearchive a user's inventory folder from the given stream
@@ -73,7 +94,7 @@ namespace OpenSim.Region.Framework.Interfaces
73 /// the loaded IAR with existing folders where possible.</param> 94 /// the loaded IAR with existing folders where possible.</param>
74 /// <returns>true if the first stage of the operation succeeded, false otherwise</returns> 95 /// <returns>true if the first stage of the operation succeeded, false otherwise</returns>
75 bool DearchiveInventory( 96 bool DearchiveInventory(
76 string firstName, string lastName, string invPath, string pass, Stream loadStream, 97 UUID id, string firstName, string lastName, string invPath, string pass, Stream loadStream,
77 Dictionary<string, object> options); 98 Dictionary<string, object> options);
78 99
79 /// <summary> 100 /// <summary>