OpenSim.Region.Framework.Interfaces.IRegionArchiverModule Interface Reference

Interface to region archive functionality More...

Inheritance diagram for OpenSim.Region.Framework.Interfaces.IRegionArchiverModule:

Public Member Functions
void	HandleLoadOarConsoleCommand (string module, string[] cmdparams)
void	HandleSaveOarConsoleCommand (string module, string[] cmdparams)
void	ArchiveRegion (string savePath, Dictionary< string, object > options)
	Archive the region to the given path More...
void	ArchiveRegion (string savePath, Guid requestId, Dictionary< string, object > options)
	Archive the region to the given path More...
void	ArchiveRegion (Stream saveStream, Guid requestId)
	Archive the region to a stream. More...
void	ArchiveRegion (Stream saveStream, Guid requestId, Dictionary< string, object > options)
	Archive the region to a stream. More...
void	DearchiveRegion (string loadPath)
	Dearchive the given region archive. This replaces the existing scene. More...
void	DearchiveRegion (string loadPath, Guid requestId, Dictionary< string, object > options)
	Dearchive the given region archive. This replaces the existing scene. More...
void	DearchiveRegion (Stream loadStream)
	Dearchive a region from a stream. This replaces the existing scene. More...
void	DearchiveRegion (Stream loadStream, Guid requestId, Dictionary< string, object > options)
	Dearchive a region from a stream. This replaces the existing scene. More...

Detailed Description

Interface to region archive functionality

Definition at line 39 of file IRegionArchiverModule.cs.

Member Function Documentation

void OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.ArchiveRegion	(	string	savePath,
		Dictionary< string, object >	options
	)

Archive the region to the given path

This method occurs asynchronously. If you want notification of when it has completed then subscribe to the EventManager.OnOarFileSaved event.

Parameters

savePath

Implemented in OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.

void OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.ArchiveRegion	(	string	savePath,
		Guid	requestId,
		Dictionary< string, object >	options
	)

Archive the region to the given path

This method occurs asynchronously. If you want notification of when it has completed then subscribe to the EventManager.OnOarFileSaved event.

Parameters

savePath
requestId	If supplied, this request Id is later returned in the saved event
options	Options for the save

Implemented in OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.

void OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.ArchiveRegion	(	Stream	saveStream,
		Guid	requestId
	)

Archive the region to a stream.

This method occurs asynchronously. If you want notification of when it has completed then subscribe to the EventManager.OnOarFileSaved event.

Parameters

saveStream
requestId	If supplied, this request Id is later returned in the saved event

Implemented in OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.

void OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.ArchiveRegion	(	Stream	saveStream,
		Guid	requestId,
		Dictionary< string, object >	options
	)

Archive the region to a stream.

This method occurs asynchronously. If you want notification of when it has completed then subscribe to the EventManager.OnOarFileSaved event.

Parameters

saveStream
requestId	If supplied, this request Id is later returned in the saved event
options	Options for the save

Implemented in OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.

void OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.DearchiveRegion

(

string

loadPath

)

Dearchive the given region archive. This replaces the existing scene.

If you want notification of when it has completed then subscribe to the EventManager.OnOarFileLoaded event.

Parameters

loadPath

Implemented in OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.

void OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.DearchiveRegion	(	string	loadPath,
		Guid	requestId,
		Dictionary< string, object >	options
	)

Dearchive the given region archive. This replaces the existing scene.

If you want notification of when it has completed then subscribe to the EventManager.OnOarFileLoaded event.

Parameters

loadPath
requestId	If supplied, this request Id is later returned in the saved event
options	Dictionary of options.

Implemented in OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.

void OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.DearchiveRegion

(

Stream

loadStream

)

Dearchive a region from a stream. This replaces the existing scene.

If you want notification of when it has completed then subscribe to the EventManager.OnOarFileLoaded event.

Parameters

loadStream

Implemented in OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.

void OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.DearchiveRegion	(	Stream	loadStream,
		Guid	requestId,
		Dictionary< string, object >	options
	)

Dearchive a region from a stream. This replaces the existing scene.

If you want notification of when it has completed then subscribe to the EventManager.OnOarFileLoaded event.

Parameters

loadStream
requestId	If supplied, this request Id is later returned in the saved event
options	Dictionary of options.

Implemented in OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.

void OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.HandleLoadOarConsoleCommand	(	string	module,
		string[]	cmdparams
	)

Implemented in OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.

void OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.HandleSaveOarConsoleCommand	(	string	module,
		string[]	cmdparams
	)

Implemented in OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.

---

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

• Region/Framework/Interfaces/IRegionArchiverModule.cs