OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
OpenSim.Region.CoreModules.Framework.ServiceThrottleModule Class Reference
Inheritance diagram for OpenSim.Region.CoreModules.Framework.ServiceThrottleModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.CoreModules.Framework.ServiceThrottleModule:
Collaboration graph
[legend]

Public Member Functions

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...
 
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 PostInitialise ()
 This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...
 
void Close ()
 This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...
 
void OnRegionHandleRequest (IClientAPI client, UUID regionID)
 
void Enqueue (string category, string itemid, Action continuation)
 Enqueue a continuation meant to get a resource from elsewhere. As usual with CPS, caller beware: if that continuation is a never-ending computation, the whole thread will be blocked, and no requests are processed More...
 

Properties

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 45 of file ServiceThrottleModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Framework.ServiceThrottleModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 78 of file ServiceThrottleModule.cs.

void OpenSim.Region.CoreModules.Framework.ServiceThrottleModule.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 106 of file ServiceThrottleModule.cs.

void OpenSim.Region.CoreModules.Framework.ServiceThrottleModule.Enqueue ( string  category,
string  itemid,
Action  continuation 
)
inline

Enqueue a continuation meant to get a resource from elsewhere. As usual with CPS, caller beware: if that continuation is a never-ending computation, the whole thread will be blocked, and no requests are processed

Parameters
categoryCategory of the resource (e.g. name, region)
itemidThe resource identifier
continuationThe continuation to be executed

Implements OpenSim.Region.Framework.Interfaces.IServiceThrottleModule.

Definition at line 167 of file ServiceThrottleModule.cs.

void OpenSim.Region.CoreModules.Framework.ServiceThrottleModule.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
sourceA IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 59 of file ServiceThrottleModule.cs.

void OpenSim.Region.CoreModules.Framework.ServiceThrottleModule.OnRegionHandleRequest ( IClientAPI  client,
UUID  regionID 
)
inline

Definition at line 142 of file ServiceThrottleModule.cs.

void OpenSim.Region.CoreModules.Framework.ServiceThrottleModule.PostInitialise ( )
inline

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 102 of file ServiceThrottleModule.cs.

void OpenSim.Region.CoreModules.Framework.ServiceThrottleModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 89 of file ServiceThrottleModule.cs.

void OpenSim.Region.CoreModules.Framework.ServiceThrottleModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 93 of file ServiceThrottleModule.cs.

Property Documentation

string OpenSim.Region.CoreModules.Framework.ServiceThrottleModule.Name
get

Definition at line 111 of file ServiceThrottleModule.cs.

Type OpenSim.Region.CoreModules.Framework.ServiceThrottleModule.ReplaceableInterface
get

Definition at line 116 of file ServiceThrottleModule.cs.


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