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

Public Member Functions

void Initialise (IConfigSource configSource)
 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 InitialiseService (IConfigSource configSource)
 
void PostInitialise ()
 This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. 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 Close ()
 This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...
 
void RemoveScene (Scene scene)
 Can be called from other modules. More...
 
void Init (Scene scene)
 Can be called from other modules. More...
 
IScene GetScene (UUID regionId)
 Retrieve the scene with the given region ID. More...
 
ISimulationService GetInnerService ()
 
bool CreateAgent (GridRegion source, GridRegion destination, AgentCircuitData aCircuit, uint teleportFlags, EntityTransferContext ctx, out string reason)
 
bool UpdateAgent (GridRegion destination, AgentData cAgentData, EntityTransferContext ctx)
 Full child agent update. More...
 
bool UpdateAgent (GridRegion destination, AgentPosition agentPosition)
 Short child agent update, mostly for position. More...
 
bool QueryAccess (GridRegion destination, UUID agentID, string agentHomeURI, bool viaTeleport, Vector3 position, List< UUID > features, EntityTransferContext ctx, out string reason)
 Returns whether a propspective user is allowed to visit the region. More...
 
bool ReleaseAgent (UUID originId, UUID agentId, string uri)
 Message from receiving region to departing region, telling it got contacted by the client. When sent over REST, it invokes the opaque uri. More...
 
bool CloseAgent (GridRegion destination, UUID id, string auth_token)
 Close agent. More...
 
bool CreateObject (GridRegion destination, Vector3 newPosition, ISceneObject sog, bool isLocalCall)
 
bool IsLocalRegion (ulong regionhandle)
 
bool IsLocalRegion (UUID id)
 

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 44 of file LocalSimulationConnector.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.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 85 of file LocalSimulationConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.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 107 of file LocalSimulationConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.CloseAgent ( GridRegion  destination,
UUID  id,
string  auth_token 
)
inline

Close agent.

Parameters
regionHandle
id
Returns

Implements OpenSim.Services.Interfaces.ISimulationService.

Definition at line 295 of file LocalSimulationConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.CreateAgent ( GridRegion  source,
GridRegion  destination,
AgentCircuitData  aCircuit,
uint  teleportFlags,
EntityTransferContext  ctx,
out string  reason 
)
inline

Agent-related communications

Implements OpenSim.Services.Interfaces.ISimulationService.

Definition at line 188 of file LocalSimulationConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.CreateObject ( GridRegion  destination,
Vector3  newPosition,
ISceneObject  sog,
bool  isLocalCall 
)
inline

Object-related communications

Implements OpenSim.Services.Interfaces.ISimulationService.

Definition at line 317 of file LocalSimulationConnector.cs.

ISimulationService OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.GetInnerService ( )
inline
IScene OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.GetScene ( UUID  regionId)
inline

Retrieve the scene with the given region ID.

Parameters
regionIdRegion identifier.
Returns
The scene.

Implements OpenSim.Services.Interfaces.ISimulationService.

Definition at line 159 of file LocalSimulationConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.Init ( Scene  scene)
inline

Can be called from other modules.

Parameters
scene

Definition at line 142 of file LocalSimulationConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.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 60 of file LocalSimulationConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.InitialiseService ( IConfigSource  configSource)
inline

Definition at line 77 of file LocalSimulationConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.IsLocalRegion ( ulong  regionhandle)
inline

Definition at line 351 of file LocalSimulationConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.IsLocalRegion ( UUID  id)
inline

Definition at line 360 of file LocalSimulationConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.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 81 of file LocalSimulationConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.QueryAccess ( GridRegion  destination,
UUID  agentID,
string  agentHomeURI,
bool  viaTeleport,
Vector3  position,
List< UUID >  features,
EntityTransferContext  ctx,
out string  reason 
)
inline

Returns whether a propspective user is allowed to visit the region.

Parameters
destinationDesired destination
agentIDThe visitor's User ID
agentHomeURIThe visitor's Home URI. Will be missing (null) in older OpenSims.
viaTeleportTrue: via teleport; False: via cross (walking)
positionPosition in the region
sversionVersion that the requesting simulator is runing. If null then no version check is carried out.
versionVersion that the target simulator is running
reason[out] Optional error message
Returns
True: ok; False: not allowed

Implements OpenSim.Services.Interfaces.ISimulationService.

Definition at line 247 of file LocalSimulationConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.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 103 of file LocalSimulationConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.ReleaseAgent ( UUID  originRegion,
UUID  id,
string  uri 
)
inline

Message from receiving region to departing region, telling it got contacted by the client. When sent over REST, it invokes the opaque uri.

Parameters
regionHandle
id
uri
Returns

Implements OpenSim.Services.Interfaces.ISimulationService.

Definition at line 279 of file LocalSimulationConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.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 94 of file LocalSimulationConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.RemoveScene ( Scene  scene)
inline

Can be called from other modules.

Parameters
scene

Definition at line 125 of file LocalSimulationConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.UpdateAgent ( GridRegion  destination,
AgentData  data,
EntityTransferContext  ctx 
)
inline

Full child agent update.

Parameters
regionHandle
data
Returns

Implements OpenSim.Services.Interfaces.ISimulationService.

Definition at line 207 of file LocalSimulationConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.UpdateAgent ( GridRegion  destination,
AgentPosition  data 
)
inline

Short child agent update, mostly for position.

Parameters
regionHandle
data
Returns

Implements OpenSim.Services.Interfaces.ISimulationService.

Definition at line 228 of file LocalSimulationConnector.cs.

Property Documentation

string OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.Name
get

Definition at line 117 of file LocalSimulationConnector.cs.

Type OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule.ReplaceableInterface
get

Definition at line 112 of file LocalSimulationConnector.cs.


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