Inheritance diagram for OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule:

Collaboration diagram for OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule:

Public Member Functions
virtual 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...

virtual void	PostInitialise ()
	This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...

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

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 cAgentData)
	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 origin, UUID id, 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)

Protected Member Functions
virtual void	InitEach (Scene scene)

virtual void	InitOnce (Scene scene)

Protected Attributes
bool	m_enabled = false

Scene	m_aScene

LocalSimulationConnectorModule	m_localBackend

SimulationServiceConnector	m_remoteConnector

bool	m_safemode

Properties
Type	ReplaceableInterface `[get]`

virtual 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 51 of file RemoteSimulationConnector.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.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 95 of file RemoteSimulationConnector.cs.

virtual void OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.Close ( )

inlinevirtual

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 91 of file RemoteSimulationConnector.cs.

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

inline

Close agent.

Parameters

regionHandle
id

Returns

Implements OpenSim.Services.Interfaces.ISimulationService.

Definition at line 239 of file RemoteSimulationConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.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 163 of file RemoteSimulationConnector.cs.

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

inline

Object-related communications

Implements OpenSim.Services.Interfaces.ISimulationService.

Definition at line 259 of file RemoteSimulationConnector.cs.

ISimulationService OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.GetInnerService ( )

inline

Implements OpenSim.Services.Interfaces.ISimulationService.

Definition at line 154 of file RemoteSimulationConnector.cs.

IScene OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.GetScene ( UUID regionId )

inline

Retrieve the scene with the given region ID.

Parameters

regionId Region identifier.

Returns: The scene.

Implements OpenSim.Services.Interfaces.ISimulationService.

Definition at line 149 of file RemoteSimulationConnector.cs.

virtual void OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.InitEach ( Scene scene )

inlineprotectedvirtual

Definition at line 133 of file RemoteSimulationConnector.cs.

virtual void OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.Initialise ( IConfigSource source )

inlinevirtual

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 66 of file RemoteSimulationConnector.cs.

virtual void OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.InitOnce ( Scene scene )

inlineprotectedvirtual

Definition at line 139 of file RemoteSimulationConnector.cs.

virtual void OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.PostInitialise ( )

inlinevirtual

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 87 of file RemoteSimulationConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.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

destination	Desired destination
agentID	The visitor's User ID
agentHomeURI	The visitor's Home URI. Will be missing (null) in older OpenSims.
viaTeleport	True: via teleport; False: via cross (walking)
position	Position in the region
sversion	Version that the requesting simulator is runing. If null then no version check is carried out.
version	Version 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 208 of file RemoteSimulationConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.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 117 of file RemoteSimulationConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.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 226 of file RemoteSimulationConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.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 108 of file RemoteSimulationConnector.cs.

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

inline

Full child agent update.

Parameters

regionHandle
data

Returns

Implements OpenSim.Services.Interfaces.ISimulationService.

Definition at line 184 of file RemoteSimulationConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.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 196 of file RemoteSimulationConnector.cs.

Member Data Documentation

Scene OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.m_aScene

protected

Definition at line 57 of file RemoteSimulationConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.m_enabled = false

protected

Definition at line 56 of file RemoteSimulationConnector.cs.

LocalSimulationConnectorModule OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.m_localBackend

protected

Definition at line 59 of file RemoteSimulationConnector.cs.

SimulationServiceConnector OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.m_remoteConnector

protected

Definition at line 60 of file RemoteSimulationConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.m_safemode

protected

Definition at line 62 of file RemoteSimulationConnector.cs.

Property Documentation

virtual string OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.Name

get

Definition at line 129 of file RemoteSimulationConnector.cs.

Type OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.ReplaceableInterface

get

Definition at line 124 of file RemoteSimulationConnector.cs.

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

Region/CoreModules/ServiceConnectorsOut/Simulation/RemoteSimulationConnector.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation