OpenSim::Region::CoreModules::World::Archiver::ArchiveReadRequest Class Reference

Handles an individual archive read request. More...

List of all members.

Public Member Functions
	ArchiveReadRequest (Scene scene, string loadPath, bool merge, bool skipAssets, Guid requestId)
	ArchiveReadRequest (Scene scene, Stream loadStream, bool merge, bool skipAssets, Guid requestId)
void	DearchiveRegion ()
	Dearchive the region embodied in this request.
void	LoadControlFile (string path, byte[] data)
	Load oar control file.
Static Public Attributes
static int	MAX_MAJOR_VERSION = 1
	The maximum major version of OAR that we can read. Minor versions shouldn't need a max number since version bumps here should be compatible.
Protected Member Functions
void	LoadObjects (List< string > serialisedSceneObjects)
	Load serialized scene objects.
void	LoadParcels (List< string > serialisedParcels)
	Load serialized parcels.
Protected Attributes
Scene	m_scene
Stream	m_loadStream
Guid	m_requestId
string	m_errorMessage
bool	m_merge
bool	m_skipAssets
Properties
bool	ControlFileLoaded [get, set]
	Has the control file been loaded for this archive?

---

Detailed Description

Handles an individual archive read request.

---

Constructor & Destructor Documentation

OpenSim::Region::CoreModules::World::Archiver::ArchiveReadRequest::ArchiveReadRequest	(	Scene	scene,
		string	loadPath,
		bool	merge,
		bool	skipAssets,
		Guid	requestId
	)			[inline]

OpenSim::Region::CoreModules::World::Archiver::ArchiveReadRequest::ArchiveReadRequest	(	Scene	scene,
		Stream	loadStream,
		bool	merge,
		bool	skipAssets,
		Guid	requestId
	)			[inline]

---

Member Function Documentation

void OpenSim::Region::CoreModules::World::Archiver::ArchiveReadRequest::DearchiveRegion

(

)

[inline]

Dearchive the region embodied in this request.

void OpenSim::Region::CoreModules::World::Archiver::ArchiveReadRequest::LoadObjects

(

List< string >

serialisedSceneObjects

)

[inline, protected]

Load serialized scene objects.

Parameters:

serialisedSceneObjects

void OpenSim::Region::CoreModules::World::Archiver::ArchiveReadRequest::LoadParcels

(

List< string >

serialisedParcels

)

[inline, protected]

Load serialized parcels.

Parameters:

serialisedParcels

void OpenSim::Region::CoreModules::World::Archiver::ArchiveReadRequest::LoadControlFile	(	string	path,
		byte[]	data
	)			[inline]

Load oar control file.

Parameters:

	path
	data

---

Member Data Documentation

int OpenSim::Region::CoreModules::World::Archiver::ArchiveReadRequest::MAX_MAJOR_VERSION = 1 [static]

The maximum major version of OAR that we can read. Minor versions shouldn't need a max number since version bumps here should be compatible.

Scene OpenSim::Region::CoreModules::World::Archiver::ArchiveReadRequest::m_scene [protected]

Stream OpenSim::Region::CoreModules::World::Archiver::ArchiveReadRequest::m_loadStream [protected]

Guid OpenSim::Region::CoreModules::World::Archiver::ArchiveReadRequest::m_requestId [protected]

string OpenSim::Region::CoreModules::World::Archiver::ArchiveReadRequest::m_errorMessage [protected]

bool OpenSim::Region::CoreModules::World::Archiver::ArchiveReadRequest::m_merge [protected]

Should the archive being loaded be merged with what is already on the region?

bool OpenSim::Region::CoreModules::World::Archiver::ArchiveReadRequest::m_skipAssets [protected]

Should we ignore any assets when reloading the archive?

---

Property Documentation

bool OpenSim::Region::CoreModules::World::Archiver::ArchiveReadRequest::ControlFileLoaded [get, set]

Has the control file been loaded for this archive?

---

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

• /home/sdague/opensim-docsgit/opensim/OpenSim/Region/CoreModules/World/Archiver/ArchiveReadRequest.cs