This module loads and saves OpenSimulator region archives More...

Inheritance diagram for OpenSim.Region.CoreModules.World.Archiver.ArchiverModule:

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

Public Member Functions
void	Initialise (IConfigSource source)
	This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created. More...

void	AddRegion (Scene scene)
	This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called. More...

void	RegionLoaded (Scene scene)
	This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module. More...

void	RemoveRegion (Scene scene)
	This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed. More...

void	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...

void	HandleLoadOarConsoleCommand (string module, string[] cmdparams)
	Load a whole region from an opensimulator archive. More...

void	HandleSaveOarConsoleCommand (string module, string[] cmdparams)
	Save a region to a file, including all the assets needed to restore it. More...

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)

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...

Protected Attributes
const string	DEFAULT_OAR_BACKUP_FILENAME = "region.oar"

Properties
Scene	Scene `[get, set]`

IRegionCombinerModule	RegionCombinerModule `[get, set]`

string	Name `[get]`

Type	ReplaceableInterface `[get]`

Properties inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase
string	Name `[get]`

Type	ReplaceableInterface `[get]`
	If this returns non-null, it is the type of an interface that this module intends to register. This will cause the loader to defer loading of this module until all other modules have been loaded. If no other module has registered the interface by then, this module will be activated, else it will remain inactive, letting the other module take over. This should return non-null ONLY in modules that are intended to be easily replaceable, e.g. stub implementations that the developer expects to be replaced by third party provided modules. More...

Detailed Description

This module loads and saves OpenSimulator region archives

Definition at line 50 of file ArchiverModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.AddRegion ( Scene scene )

inline

This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 79 of file ArchiverModule.cs.

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

inline

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

Implements OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.

Definition at line 294 of file ArchiverModule.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.ArchiveRegion	(	string	savePath,
		Guid	requestId,
		Dictionary< string, object >	options
	)

inline

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

Implements OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.

Definition at line 299 of file ArchiverModule.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.ArchiveRegion ( Stream saveStream )

inline

Definition at line 307 of file ArchiverModule.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.ArchiveRegion	(	Stream	saveStream,
		Guid	requestId
	)

inline

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

Implements OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.

Definition at line 312 of file ArchiverModule.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.ArchiveRegion	(	Stream	saveStream,
		Guid	requestId,
		Dictionary< string, object >	options
	)

inline

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

Implements OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.

Definition at line 317 of file ArchiverModule.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.Close ( )

inline

This is the inverse to Initialise. After a Close(), this instance won't be usable anymore.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 95 of file ArchiverModule.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.DearchiveRegion ( string loadPath )

inline

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

Implements OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.

Definition at line 322 of file ArchiverModule.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.DearchiveRegion	(	string	loadPath,
		Guid	requestId,
		Dictionary< string, object >	options
	)

inline

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.

Implements OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.

Definition at line 328 of file ArchiverModule.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.DearchiveRegion ( Stream loadStream )

inline

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

Implements OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.

Definition at line 336 of file ArchiverModule.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.DearchiveRegion	(	Stream	loadStream,
		Guid	requestId,
		Dictionary< string, object >	options
	)

inline

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.

Implements OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.

Definition at line 341 of file ArchiverModule.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.HandleLoadOarConsoleCommand	(	string	module,
		string[]	cmdparams
	)

inline

Load a whole region from an opensimulator archive.

Parameters

cmdparams

Implements OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.

Definition at line 103 of file ArchiverModule.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.HandleSaveOarConsoleCommand	(	string	module,
		string[]	cmdparams
	)

inline

Save a region to a file, including all the assets needed to restore it.

Parameters

cmdparams

Implements OpenSim.Region.Framework.Interfaces.IRegionArchiverModule.

Definition at line 262 of file ArchiverModule.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.Initialise ( IConfigSource source )

inline

This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created.

Parameters

source A IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 74 of file ArchiverModule.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.RegionLoaded ( Scene scene )

inline

This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 86 of file ArchiverModule.cs.

void OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.RemoveRegion ( Scene scene )

inline

This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 91 of file ArchiverModule.cs.

Member Data Documentation

const string OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.DEFAULT_OAR_BACKUP_FILENAME = "region.oar"

protected

The file used to load and save an opensimulator archive if no filename has been specified

Definition at line 61 of file ArchiverModule.cs.

Property Documentation

string OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.Name

get

Definition at line 64 of file ArchiverModule.cs.

IRegionCombinerModule OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.RegionCombinerModule

getset

Definition at line 56 of file ArchiverModule.cs.

Type OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.ReplaceableInterface

get

Definition at line 69 of file ArchiverModule.cs.

Scene OpenSim.Region.CoreModules.World.Archiver.ArchiverModule.Scene

getset

Definition at line 55 of file ArchiverModule.cs.

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

Region/CoreModules/World/Archiver/ArchiverModule.cs

Public Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation