Inheritance diagram for OpenSim.Region.CoreModules.Framework.CapabilitiesModule:

Collaboration diagram for OpenSim.Region.CoreModules.Framework.CapabilitiesModule:

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	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 ()

void	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...

void	CreateCaps (UUID agentId, uint circuitCode)
	Add a caps handler for the given agent. If the CAPS handler already exists for this agent, then it is replaced by a new CAPS handler. More...

void	RemoveCaps (UUID agentId, uint circuitCode)
	Remove the caps handler for a given agent. More...

Caps	GetCapsForUser (uint circuitCode)
	Will return null if the agent doesn't have a caps handler registered More...

void	ActivateCaps (uint circuitCode)

void	SetAgentCapsSeeds (AgentCircuitData agent)

string	GetCapsPath (UUID agentId)

Dictionary< ulong, string >	GetChildrenSeeds (UUID agentID)

void	DropChildSeed (UUID agentID, ulong handle)

string	GetChildSeed (UUID agentID, ulong handle)

void	SetChildrenSeed (UUID agentID, Dictionary< ulong, string > seeds)

void	DumpChildrenSeeds (UUID agentID)

Protected Attributes
Scene	m_scene

Dictionary< uint, Caps >	m_capsObjects = new Dictionary<uint, Caps>()
	Each agent has its own capabilities handler. More...

Dictionary< UUID, string >	m_capsPaths = new Dictionary<UUID, string>()

Dictionary< UUID, Dictionary < ulong, string > >	m_childrenSeeds = new Dictionary<UUID, Dictionary<ulong, string>>()

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 49 of file CapabilitiesModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Framework.CapabilitiesModule.ActivateCaps ( uint circuitCode )

inline

Implements OpenSim.Region.Framework.Interfaces.ICapabilitiesModule.

Definition at line 232 of file CapabilitiesModule.cs.

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

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

void OpenSim.Region.CoreModules.Framework.CapabilitiesModule.CreateCaps	(	UUID	agentId,
		uint	circuitCode
	)

inline

Add a caps handler for the given agent. If the CAPS handler already exists for this agent, then it is replaced by a new CAPS handler.

Parameters

agentId
capsObjectPath

Implements OpenSim.Region.Framework.Interfaces.ICapabilitiesModule.

Definition at line 121 of file CapabilitiesModule.cs.

void OpenSim.Region.CoreModules.Framework.CapabilitiesModule.DropChildSeed	(	UUID	agentID,
		ulong	handle
	)

inline

Implements OpenSim.Region.Framework.Interfaces.ICapabilitiesModule.

Definition at line 277 of file CapabilitiesModule.cs.

void OpenSim.Region.CoreModules.Framework.CapabilitiesModule.DumpChildrenSeeds ( UUID agentID )

inline

Definition at line 315 of file CapabilitiesModule.cs.

Caps OpenSim.Region.CoreModules.Framework.CapabilitiesModule.GetCapsForUser ( uint circuitCode )

inline

Will return null if the agent doesn't have a caps handler registered

Parameters

agentId

Implements OpenSim.Region.Framework.Interfaces.ICapabilitiesModule.

Definition at line 219 of file CapabilitiesModule.cs.

string OpenSim.Region.CoreModules.Framework.CapabilitiesModule.GetCapsPath ( UUID agentId )

inline

Implements OpenSim.Region.Framework.Interfaces.ICapabilitiesModule.

Definition at line 253 of file CapabilitiesModule.cs.

Dictionary<ulong, string> OpenSim.Region.CoreModules.Framework.CapabilitiesModule.GetChildrenSeeds ( UUID agentID )

inline

Implements OpenSim.Region.Framework.Interfaces.ICapabilitiesModule.

Definition at line 266 of file CapabilitiesModule.cs.

string OpenSim.Region.CoreModules.Framework.CapabilitiesModule.GetChildSeed	(	UUID	agentID,
		ulong	handle
	)

inline

Implements OpenSim.Region.Framework.Interfaces.ICapabilitiesModule.

Definition at line 290 of file CapabilitiesModule.cs.

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

void OpenSim.Region.CoreModules.Framework.CapabilitiesModule.PostInitialise ( )

inline

Definition at line 105 of file CapabilitiesModule.cs.

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

void OpenSim.Region.CoreModules.Framework.CapabilitiesModule.RemoveCaps	(	UUID	agentId,
		uint	circuitCode
	)

inline

Remove the caps handler for a given agent.

Parameters

agentId

Implements OpenSim.Region.Framework.Interfaces.ICapabilitiesModule.

Definition at line 181 of file CapabilitiesModule.cs.

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

void OpenSim.Region.CoreModules.Framework.CapabilitiesModule.SetAgentCapsSeeds ( AgentCircuitData agent )

inline

Implements OpenSim.Region.Framework.Interfaces.ICapabilitiesModule.

Definition at line 243 of file CapabilitiesModule.cs.

void OpenSim.Region.CoreModules.Framework.CapabilitiesModule.SetChildrenSeed	(	UUID	agentID,
		Dictionary< ulong, string >	seeds
	)

inline

Implements OpenSim.Region.Framework.Interfaces.ICapabilitiesModule.

Definition at line 307 of file CapabilitiesModule.cs.

Member Data Documentation

Dictionary<uint, Caps> OpenSim.Region.CoreModules.Framework.CapabilitiesModule.m_capsObjects = new Dictionary<uint, Caps>()

protected

Each agent has its own capabilities handler.

Definition at line 60 of file CapabilitiesModule.cs.

Dictionary<UUID, string> OpenSim.Region.CoreModules.Framework.CapabilitiesModule.m_capsPaths = new Dictionary<UUID, string>()

protected

Definition at line 62 of file CapabilitiesModule.cs.

Dictionary<UUID, Dictionary<ulong, string> > OpenSim.Region.CoreModules.Framework.CapabilitiesModule.m_childrenSeeds = new Dictionary<UUID, Dictionary<ulong, string>>()

protected

Definition at line 65 of file CapabilitiesModule.cs.

Scene OpenSim.Region.CoreModules.Framework.CapabilitiesModule.m_scene

protected

Definition at line 55 of file CapabilitiesModule.cs.

Property Documentation

string OpenSim.Region.CoreModules.Framework.CapabilitiesModule.Name

get

Definition at line 112 of file CapabilitiesModule.cs.

Type OpenSim.Region.CoreModules.Framework.CapabilitiesModule.ReplaceableInterface

get

Definition at line 117 of file CapabilitiesModule.cs.

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

Region/CoreModules/Framework/Caps/CapabilitiesModule.cs

Public Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation