OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Classes | Public Member Functions | Properties | List of all members
OpenSim.Region.ClientStack.Linden.WebFetchInvDescModule Class Reference

This module implements both WebFetchInventoryDescendents and FetchInventoryDescendents2 capabilities. More...

Inheritance diagram for OpenSim.Region.ClientStack.Linden.WebFetchInvDescModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.ClientStack.Linden.WebFetchInvDescModule:
Collaboration graph
[legend]

Public Member Functions

 WebFetchInvDescModule ()
 
 WebFetchInvDescModule (bool processQueuedResultsAsync)
 
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 s)
 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 RemoveRegion (Scene s)
 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 RegionLoaded (Scene s)
 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 PostInitialise ()
 
void Close ()
 This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...
 

Properties

bool ProcessQueuedRequestsAsync [get, set]
 Control whether requests will be processed asynchronously. More...
 
static int ProcessedRequestsCount [get, set]
 Number of inventory requests processed by this module. More...
 
Scene Scene [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 implements both WebFetchInventoryDescendents and FetchInventoryDescendents2 capabilities.

Definition at line 56 of file WebFetchInvDescModule.cs.

Constructor & Destructor Documentation

OpenSim.Region.ClientStack.Linden.WebFetchInvDescModule.WebFetchInvDescModule ( )
inline

Definition at line 109 of file WebFetchInvDescModule.cs.

OpenSim.Region.ClientStack.Linden.WebFetchInvDescModule.WebFetchInvDescModule ( bool  processQueuedResultsAsync)
inline

Definition at line 111 of file WebFetchInvDescModule.cs.

Member Function Documentation

void OpenSim.Region.ClientStack.Linden.WebFetchInvDescModule.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 132 of file WebFetchInvDescModule.cs.

void OpenSim.Region.ClientStack.Linden.WebFetchInvDescModule.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 222 of file WebFetchInvDescModule.cs.

void OpenSim.Region.ClientStack.Linden.WebFetchInvDescModule.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 116 of file WebFetchInvDescModule.cs.

void OpenSim.Region.ClientStack.Linden.WebFetchInvDescModule.PostInitialise ( )
inline

Definition at line 218 of file WebFetchInvDescModule.cs.

void OpenSim.Region.ClientStack.Linden.WebFetchInvDescModule.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 154 of file WebFetchInvDescModule.cs.

void OpenSim.Region.ClientStack.Linden.WebFetchInvDescModule.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 140 of file WebFetchInvDescModule.cs.

Property Documentation

string OpenSim.Region.ClientStack.Linden.WebFetchInvDescModule.Name
get

Definition at line 240 of file WebFetchInvDescModule.cs.

int OpenSim.Region.ClientStack.Linden.WebFetchInvDescModule.ProcessedRequestsCount
staticgetset

Number of inventory requests processed by this module.

It's the PollServiceRequestManager that actually sends completed requests back to the requester.

Definition at line 83 of file WebFetchInvDescModule.cs.

bool OpenSim.Region.ClientStack.Linden.WebFetchInvDescModule.ProcessQueuedRequestsAsync
getset

Control whether requests will be processed asynchronously.

Defaults to true. Can currently not be changed once a region has been added to the module.

Definition at line 75 of file WebFetchInvDescModule.cs.

Type OpenSim.Region.ClientStack.Linden.WebFetchInvDescModule.ReplaceableInterface
get

Definition at line 243 of file WebFetchInvDescModule.cs.

Scene OpenSim.Region.ClientStack.Linden.WebFetchInvDescModule.Scene
getset

Definition at line 88 of file WebFetchInvDescModule.cs.


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