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

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 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 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 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 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...
 
bool Check (string id)
 Check whether an asset with the specified id exists in the cache. More...
 
void Cache (AssetBase asset)
 Cache the specified asset. More...
 
AssetBase Get (string id)
 Get an asset by its id. More...
 
void Expire (string id)
 Expire an asset from the cache. More...
 
void Clear ()
 Clear the cache. 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 43 of file CoreAssetCache.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Asset.CoreAssetCache.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 98 of file CoreAssetCache.cs.

void OpenSim.Region.CoreModules.Asset.CoreAssetCache.Cache ( AssetBase  asset)
inline

Cache the specified asset.

Parameters
asset

Implements OpenSim.Framework.IImprovedAssetCache.

Definition at line 121 of file CoreAssetCache.cs.

bool OpenSim.Region.CoreModules.Asset.CoreAssetCache.Check ( string  id)
inline

Check whether an asset with the specified id exists in the cache.

Parameters
id

Implements OpenSim.Framework.IImprovedAssetCache.

Definition at line 115 of file CoreAssetCache.cs.

void OpenSim.Region.CoreModules.Asset.CoreAssetCache.Clear ( )
inline

Clear the cache.

Implements OpenSim.Framework.IImprovedAssetCache.

Definition at line 137 of file CoreAssetCache.cs.

void OpenSim.Region.CoreModules.Asset.CoreAssetCache.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 94 of file CoreAssetCache.cs.

void OpenSim.Region.CoreModules.Asset.CoreAssetCache.Expire ( string  id)
inline

Expire an asset from the cache.

Parameters
id

Implements OpenSim.Framework.IImprovedAssetCache.

Definition at line 132 of file CoreAssetCache.cs.

AssetBase OpenSim.Region.CoreModules.Asset.CoreAssetCache.Get ( string  id)
inline

Get an asset by its id.

Parameters
id
Returns
null if the asset does not exist.

Implements OpenSim.Framework.IImprovedAssetCache.

Definition at line 127 of file CoreAssetCache.cs.

void OpenSim.Region.CoreModules.Asset.CoreAssetCache.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 62 of file CoreAssetCache.cs.

void OpenSim.Region.CoreModules.Asset.CoreAssetCache.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 90 of file CoreAssetCache.cs.

void OpenSim.Region.CoreModules.Asset.CoreAssetCache.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 108 of file CoreAssetCache.cs.

void OpenSim.Region.CoreModules.Asset.CoreAssetCache.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 104 of file CoreAssetCache.cs.

Property Documentation

string OpenSim.Region.CoreModules.Asset.CoreAssetCache.Name
get

Definition at line 53 of file CoreAssetCache.cs.

Type OpenSim.Region.CoreModules.Asset.CoreAssetCache.ReplaceableInterface
get

Definition at line 58 of file CoreAssetCache.cs.


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