Inheritance diagram for OpenSim.Region.CoreModules.Asset.FlotsamAssetCache:

Collaboration diagram for OpenSim.Region.CoreModules.Asset.FlotsamAssetCache:

Public Member Functions
	FlotsamAssetCache ()

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

void	Cache (AssetBase asset)
	Cache the specified asset. More...

AssetBase	Get (string id)
	Get an asset by its id. More...

bool	Check (string id)
	Check whether an asset with the specified id exists in the cache. More...

AssetBase	GetCached (string id)
	Synchronously fetches an asset from the local cache only. More...

void	Expire (string id)
	Expire an asset from the cache. More...

void	Clear ()
	Clear the cache. More...

AssetMetadata	GetMetadata (string id)
	Get an asset's metadata More...

byte[]	GetData (string id)
	Get an asset's data, ignoring the metadata. More...

bool	Get (string id, object sender, AssetRetrieved handler)

bool[]	AssetsExist (string[] ids)
	Check if assets exist in the database. More...

string	Store (AssetBase asset)
	Creates a new asset More...

bool	UpdateContent (string id, byte[] data)
	Update an asset's content More...

bool	Delete (string id)
	Delete an asset More...

Public Member Functions inherited from OpenSim.Services.Interfaces.IAssetService
bool	Get (string id, Object sender, AssetRetrieved handler)
	Get an asset synchronously or asynchronously (depending on whether it is locally cached) and fire a callback with the fetched asset More...

Properties
Type	ReplaceableInterface `[get]`

string	Name `[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 58 of file FlotsamAssetCache.cs.

Constructor & Destructor Documentation

OpenSim.Region.CoreModules.Asset.FlotsamAssetCache.FlotsamAssetCache ( )

inline

Definition at line 108 of file FlotsamAssetCache.cs.

Member Function Documentation

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

bool [] OpenSim.Region.CoreModules.Asset.FlotsamAssetCache.AssetsExist ( string[] ids )

inline

Check if assets exist in the database.

Parameters

ids	The assets' IDs

Returns: For each asset: true if it exists, false otherwise

Implements OpenSim.Services.Interfaces.IAssetService.

Definition at line 1059 of file FlotsamAssetCache.cs.

void OpenSim.Region.CoreModules.Asset.FlotsamAssetCache.Cache ( AssetBase asset )

inline

Cache the specified asset.

Parameters

asset

Implements OpenSim.Framework.IImprovedAssetCache.

Definition at line 303 of file FlotsamAssetCache.cs.

bool OpenSim.Region.CoreModules.Asset.FlotsamAssetCache.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 481 of file FlotsamAssetCache.cs.

void OpenSim.Region.CoreModules.Asset.FlotsamAssetCache.Clear ( )

inline

Clear the cache.

Implements OpenSim.Framework.IImprovedAssetCache.

Definition at line 523 of file FlotsamAssetCache.cs.

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

bool OpenSim.Region.CoreModules.Asset.FlotsamAssetCache.Delete ( string id )

inline

Delete an asset

Parameters

id

Returns

Implements OpenSim.Services.Interfaces.IAssetService.

Definition at line 1091 of file FlotsamAssetCache.cs.

void OpenSim.Region.CoreModules.Asset.FlotsamAssetCache.Expire ( string id )

inline

Expire an asset from the cache.

Parameters

id

Implements OpenSim.Framework.IImprovedAssetCache.

Definition at line 496 of file FlotsamAssetCache.cs.

AssetBase OpenSim.Region.CoreModules.Asset.FlotsamAssetCache.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 454 of file FlotsamAssetCache.cs.

bool OpenSim.Region.CoreModules.Asset.FlotsamAssetCache.Get	(	string	id,
		object	sender,
		AssetRetrieved	handler
	)

inline

Definition at line 1052 of file FlotsamAssetCache.cs.

AssetBase OpenSim.Region.CoreModules.Asset.FlotsamAssetCache.GetCached ( string id )

inline

Synchronously fetches an asset from the local cache only.

Parameters

id Asset ID

Returns: The fetched asset, or null if it did not exist in the local cache

Implements OpenSim.Services.Interfaces.IAssetService.

Definition at line 491 of file FlotsamAssetCache.cs.

byte [] OpenSim.Region.CoreModules.Asset.FlotsamAssetCache.GetData ( string id )

inline

Get an asset's data, ignoring the metadata.

Parameters

id

Returns: null if there is no such asset

Implements OpenSim.Services.Interfaces.IAssetService.

Definition at line 1046 of file FlotsamAssetCache.cs.

AssetMetadata OpenSim.Region.CoreModules.Asset.FlotsamAssetCache.GetMetadata ( string id )

inline

Get an asset's metadata

Parameters

id

Returns

Implements OpenSim.Services.Interfaces.IAssetService.

Definition at line 1040 of file FlotsamAssetCache.cs.

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

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

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

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

string OpenSim.Region.CoreModules.Asset.FlotsamAssetCache.Store ( AssetBase asset )

inline

Creates a new asset

Returns a random ID if none is passed via the asset argument.

Parameters

asset

Returns: The Asset ID, or string.Empty if an error occurred

Implements OpenSim.Services.Interfaces.IAssetService.

Definition at line 1071 of file FlotsamAssetCache.cs.

bool OpenSim.Region.CoreModules.Asset.FlotsamAssetCache.UpdateContent	(	string	id,
		byte[]	data
	)

inline

Update an asset's content

Attachments and bare scripts need this!!

Parameters

id
data

Returns

Implements OpenSim.Services.Interfaces.IAssetService.

Definition at line 1083 of file FlotsamAssetCache.cs.

Property Documentation

string OpenSim.Region.CoreModules.Asset.FlotsamAssetCache.Name

get

Definition at line 120 of file FlotsamAssetCache.cs.

Type OpenSim.Region.CoreModules.Asset.FlotsamAssetCache.ReplaceableInterface

get

Definition at line 115 of file FlotsamAssetCache.cs.

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

Region/CoreModules/Asset/FlotsamAssetCache.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation