OpenSim.Region.UserStatistics.WebStatsModule Class Reference

Inheritance diagram for OpenSim.Region.UserStatistics.WebStatsModule:

Collaboration diagram for OpenSim.Region.UserStatistics.WebStatsModule:

Public Member Functions
virtual void	Initialise (IConfigSource config)
	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...
virtual void	PostInitialise ()
	This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...
virtual 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...
virtual void	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...

Protected Member Functions
virtual void	AddEventHandlers ()

Properties
virtual 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

Definition at line 56 of file WebStatsModule.cs.

Member Function Documentation

virtual void OpenSim.Region.UserStatistics.WebStatsModule.AddEventHandlers ( )

inlineprotectedvirtual

Definition at line 359 of file WebStatsModule.cs.

virtual void OpenSim.Region.UserStatistics.WebStatsModule.AddRegion ( Scene  scene )

inlinevirtual

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 137 of file WebStatsModule.cs.

virtual void OpenSim.Region.UserStatistics.WebStatsModule.Close ( )

inlinevirtual

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 174 of file WebStatsModule.cs.

virtual void OpenSim.Region.UserStatistics.WebStatsModule.Initialise ( IConfigSource  source )

inlinevirtual

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 81 of file WebStatsModule.cs.

virtual void OpenSim.Region.UserStatistics.WebStatsModule.PostInitialise ( )

inlinevirtual

This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised.

Implements OpenSim.Region.Framework.Interfaces.ISharedRegionModule.

Definition at line 89 of file WebStatsModule.cs.

void OpenSim.Region.UserStatistics.WebStatsModule.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 157 of file WebStatsModule.cs.

void OpenSim.Region.UserStatistics.WebStatsModule.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 161 of file WebStatsModule.cs.

Property Documentation

virtual string OpenSim.Region.UserStatistics.WebStatsModule.Name

get

Definition at line 188 of file WebStatsModule.cs.

Type OpenSim.Region.UserStatistics.WebStatsModule.ReplaceableInterface

get

Definition at line 193 of file WebStatsModule.cs.

---

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

• Region/OptionalModules/UserStatistics/WebStatsModule.cs