Prepare to write out an archive. More...

Collaboration diagram for OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest:

Public Member Functions
	ArchiveWriteRequest (Scene scene, string savePath, Guid requestId)
	Constructor More...

	ArchiveWriteRequest (Scene scene, Stream saveStream, Guid requestId)
	Constructor. More...

void	ArchiveRegion (Dictionary< string, object > options)
	Archive the region requested. More...

string	CreateControlFile (ArchiveScenesGroup scenesGroup)
	Create the control file. More...

Static Public Attributes
static int	MIN_MAJOR_VERSION = 0
	The minimum major version of OAR that we can write. More...

static int	MAX_MAJOR_VERSION = 1
	The maximum major version of OAR that we can write. More...

Protected Member Functions
	ArchiveWriteRequest (Scene scene, Guid requestId)

void	Save (Scene scene, List< SceneObjectGroup > sceneObjects, string regionDir)

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

void	CloseArchive (string errorMessage)
	Closes the archive and notifies that we're done. More...

Static Protected Member Functions
static void	WriteRegionInfo (Scene scene, XmlTextWriter xtw)

Protected Attributes
Scene	m_rootScene

Stream	m_saveStream

TarArchiveWriter	m_archiveWriter

Guid	m_requestId

Dictionary< string, object >	m_options

Properties
bool	MultiRegionFormat `[get, set]`
	Whether we're saving a multi-region archive. More...

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

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

Detailed Description

Prepare to write out an archive.

Definition at line 56 of file ArchiveWriteRequest.cs.

Constructor & Destructor Documentation

OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.ArchiveWriteRequest	(	Scene	scene,
		string	savePath,
		Guid	requestId
	)

inline

Constructor

Parameters

module	Calling module
savePath	The path to which to save data.
requestId	The id associated with this request

Exceptions

System.IO.IOException If there was a problem opening a stream for the file specified by the savePath

Definition at line 101 of file ArchiveWriteRequest.cs.

OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.ArchiveWriteRequest	(	Scene	scene,
		Stream	saveStream,
		Guid	requestId
	)

inline

Constructor.

Parameters

scene	The root scene to archive
saveStream	The stream to which to save data.
requestId	The id associated with this request

Definition at line 122 of file ArchiveWriteRequest.cs.

OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.ArchiveWriteRequest	(	Scene	scene,
		Guid	requestId
	)

inlineprotected

Definition at line 127 of file ArchiveWriteRequest.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.ArchiveRegion ( Dictionary< string, object > options )

inline

Archive the region requested.

Exceptions

System.IO.IOException if there was an io problem with creating the file

Definition at line 142 of file ArchiveWriteRequest.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.CloseArchive ( string errorMessage )

inlineprotected

Closes the archive and notifies that we're done.

Parameters

errorMessage The error that occurred, or empty for success

Definition at line 623 of file ArchiveWriteRequest.cs.

string OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.CreateControlFile ( ArchiveScenesGroup scenesGroup )

inline

Create the control file.

Returns

Definition at line 378 of file ArchiveWriteRequest.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.ReceivedAllAssets	(	ICollection< UUID >	assetsFoundUuids,
		ICollection< UUID >	assetsNotFoundUuids,
		bool	timedOut
	)

inlineprotected

Definition at line 594 of file ArchiveWriteRequest.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.Save	(	Scene	scene,
		List< SceneObjectGroup >	sceneObjects,
		string	regionDir
	)

inlineprotected

Definition at line 544 of file ArchiveWriteRequest.cs.

static void OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.WriteRegionInfo	(	Scene	scene,
		XmlTextWriter	xtw
	)

inlinestaticprotected

Definition at line 523 of file ArchiveWriteRequest.cs.

Member Data Documentation

TarArchiveWriter OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.m_archiveWriter

protected

Definition at line 88 of file ArchiveWriteRequest.cs.

Dictionary<string, object> OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.m_options

protected

Definition at line 90 of file ArchiveWriteRequest.cs.

Guid OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.m_requestId

protected

Definition at line 89 of file ArchiveWriteRequest.cs.

Scene OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.m_rootScene

protected

Definition at line 86 of file ArchiveWriteRequest.cs.

Stream OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.m_saveStream

protected

Definition at line 87 of file ArchiveWriteRequest.cs.

int OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.MAX_MAJOR_VERSION = 1

static

The maximum major version of OAR that we can write.

Definition at line 68 of file ArchiveWriteRequest.cs.

int OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.MIN_MAJOR_VERSION = 0

static

The minimum major version of OAR that we can write.

Definition at line 63 of file ArchiveWriteRequest.cs.

Property Documentation

string OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.FilterContent

getset

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

Definition at line 84 of file ArchiveWriteRequest.cs.

bool OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.MultiRegionFormat

getset

Whether we're saving a multi-region archive.

Definition at line 73 of file ArchiveWriteRequest.cs.

bool OpenSim.Region.CoreModules.World.Archiver.ArchiveWriteRequest.SaveAssets

getset

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

Definition at line 78 of file ArchiveWriteRequest.cs.

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

Region/CoreModules/World/Archiver/ArchiveWriteRequest.cs

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation