Collaboration diagram for OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest:

Public Member Functions
	InventoryArchiveWriteRequest (UUID id, InventoryArchiverModule module, Scene scene, UserAccount userInfo, string invPath, string savePath)
	Constructor More...

	InventoryArchiveWriteRequest (UUID id, InventoryArchiverModule module, Scene scene, UserAccount userInfo, string invPath, Stream saveStream)
	Constructor More...

void	Execute (Dictionary< string, object > options, IUserAccountService userAccountService)
	Execute the inventory write request More...

string	CreateControlFile (Dictionary< string, object > options)
	Create the control file for the archive More...

Static Public Member Functions
static string	CreateArchiveFolderName (InventoryFolderBase folder)
	Create the archive name for a particular folder. More...

static string	CreateArchiveItemName (InventoryItemBase item)
	Create the archive name for a particular item. More...

static string	CreateArchiveFolderName (string name, UUID id)
	Create an archive folder name given its constituent components More...

static string	CreateArchiveItemName (string name, UUID id)
	Create an archive item name given its constituent components More...

Protected Member Functions
void	ReceivedAllAssets (ICollection< UUID > assetsFoundUuids, ICollection< UUID > assetsNotFoundUuids, bool timedOut)

void	SaveInvItem (InventoryItemBase inventoryItem, string path, Dictionary< string, object > options, IUserAccountService userAccountService)

void	SaveInvFolder (InventoryFolderBase inventoryFolder, string path, bool saveThisFolderItself, Dictionary< string, object > options, IUserAccountService userAccountService)
	Save an inventory folder More...

void	SaveUsers ()
	Save information for the users that we've collected. More...

Protected Attributes
TarArchiveWriter	m_archiveWriter

UuidGatherer	m_assetGatherer

Scene	m_scene

UUID	m_id

Dictionary< UUID, int >	m_userUuids = new Dictionary<UUID, int>()

Properties
bool	SaveAssets `[get, set]`
	Determine whether this archive will save assets. Default is true. More...

string	FilterContent `[get, set]`
	Determines which items will be included in the archive, according to their permissions. Default is null, meaning no permission checks. More...

int	CountItems `[get, set]`
	Counter for inventory items saved to archive for passing to compltion event More...

int	CountFiltered `[get, set]`
	Counter for inventory items skipped due to permission filter option for passing to compltion event More...

Detailed Description

Definition at line 51 of file InventoryArchiveWriteRequest.cs.

Constructor & Destructor Documentation

OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.InventoryArchiveWriteRequest	(	UUID	id,
		InventoryArchiverModule	module,
		Scene	scene,
		UserAccount	userInfo,
		string	invPath,
		string	savePath
	)

inline

Constructor

Definition at line 110 of file InventoryArchiveWriteRequest.cs.

OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.InventoryArchiveWriteRequest	(	UUID	id,
		InventoryArchiverModule	module,
		Scene	scene,
		UserAccount	userInfo,
		string	invPath,
		Stream	saveStream
	)

inline

Constructor

Definition at line 126 of file InventoryArchiveWriteRequest.cs.

Member Function Documentation

static string OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.CreateArchiveFolderName ( InventoryFolderBase folder )

inlinestatic

Create the archive name for a particular folder.

These names are prepended with an inventory folder's UUID so that more than one folder can have the same name

Parameters

folder

Returns

Definition at line 483 of file InventoryArchiveWriteRequest.cs.

static string OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.CreateArchiveFolderName	(	string	name,
		UUID	id
	)

inlinestatic

Create an archive folder name given its constituent components

Parameters

name
id

Returns

Definition at line 508 of file InventoryArchiveWriteRequest.cs.

static string OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.CreateArchiveItemName ( InventoryItemBase item )

inlinestatic

Create the archive name for a particular item.

These names are prepended with an inventory item's UUID so that more than one item can have the same name

Parameters

item

Returns

Definition at line 497 of file InventoryArchiveWriteRequest.cs.

static string OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.CreateArchiveItemName	(	string	name,
		UUID	id
	)

inlinestatic

Create an archive item name given its constituent components

Parameters

name
id

Returns

Definition at line 523 of file InventoryArchiveWriteRequest.cs.

string OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.CreateControlFile ( Dictionary< string, object > options )

inline

Create the control file for the archive

Parameters

options

Returns

Definition at line 537 of file InventoryArchiveWriteRequest.cs.

void OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.Execute	(	Dictionary< string, object >	options,
		IUserAccountService	userAccountService
	)

inline

Execute the inventory write request

Definition at line 311 of file InventoryArchiveWriteRequest.cs.

void OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.ReceivedAllAssets	(	ICollection< UUID >	assetsFoundUuids,
		ICollection< UUID >	assetsNotFoundUuids,
		bool	timedOut
	)

inlineprotected

Definition at line 142 of file InventoryArchiveWriteRequest.cs.

void OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.SaveInvFolder	(	InventoryFolderBase	inventoryFolder,
		string	path,
		bool	saveThisFolderItself,
		Dictionary< string, object >	options,
		IUserAccountService	userAccountService
	)

inlineprotected

Save an inventory folder

Parameters

inventoryFolder	The inventory folder to save
path	The path to which the folder should be saved
saveThisFolderItself	If true, save this folder itself. If false, only saves contents
options
userAccountService

Definition at line 235 of file InventoryArchiveWriteRequest.cs.

void OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.SaveInvItem	(	InventoryItemBase	inventoryItem,
		string	path,
		Dictionary< string, object >	options,
		IUserAccountService	userAccountService
	)

inlineprotected

Definition at line 171 of file InventoryArchiveWriteRequest.cs.

void OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.SaveUsers ( )

inlineprotected

Save information for the users that we've collected.

Definition at line 452 of file InventoryArchiveWriteRequest.cs.

Member Data Documentation

TarArchiveWriter OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.m_archiveWriter

protected

Definition at line 84 of file InventoryArchiveWriteRequest.cs.

UuidGatherer OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.m_assetGatherer

protected

Definition at line 85 of file InventoryArchiveWriteRequest.cs.

UUID OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.m_id

protected

ID of this request

Definition at line 95 of file InventoryArchiveWriteRequest.cs.

Scene OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.m_scene

protected

We only use this to request modules

Definition at line 90 of file InventoryArchiveWriteRequest.cs.

Dictionary<UUID, int> OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.m_userUuids = new Dictionary<UUID, int>()

protected

Used to collect the uuids of the users that we need to save into the archive

Definition at line 100 of file InventoryArchiveWriteRequest.cs.

Property Documentation

int OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.CountFiltered

getset

Counter for inventory items skipped due to permission filter option for passing to compltion event

Definition at line 74 of file InventoryArchiveWriteRequest.cs.

int OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.CountItems

getset

Counter for inventory items saved to archive for passing to compltion event

Definition at line 69 of file InventoryArchiveWriteRequest.cs.

string OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.FilterContent

getset

Determines which items will be included in the archive, according to their permissions. Default is null, meaning no permission checks.

Definition at line 64 of file InventoryArchiveWriteRequest.cs.

bool OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.InventoryArchiveWriteRequest.SaveAssets

getset

Determine whether this archive will save assets. Default is true.

Definition at line 58 of file InventoryArchiveWriteRequest.cs.

The documentation for this class was generated from the following file:

Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation