OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | List of all members
OpenSim.Services.Interfaces.ISimulationService Interface Reference
Inheritance diagram for OpenSim.Services.Interfaces.ISimulationService:
Inheritance graph
[legend]

Public Member Functions

IScene GetScene (UUID regionId)
 Retrieve the scene with the given region ID. More...
 
ISimulationService GetInnerService ()
 
bool CreateAgent (GridRegion source, GridRegion destination, AgentCircuitData aCircuit, uint flags, EntityTransferContext ctx, out string reason)
 Ask the simulator hosting the destination to create an agent on that region. More...
 
bool UpdateAgent (GridRegion destination, AgentData data, EntityTransferContext ctx)
 Full child agent update. More...
 
bool UpdateAgent (GridRegion destination, AgentPosition data)
 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 originRegion, 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)
 Create an object in the destination region. This message is used primarily for prim crossing. More...
 

Detailed Description

Definition at line 37 of file ISimulationService.cs.

Member Function Documentation

bool OpenSim.Services.Interfaces.ISimulationService.CloseAgent ( GridRegion  destination,
UUID  id,
string  auth_token 
)
bool OpenSim.Services.Interfaces.ISimulationService.CreateAgent ( GridRegion  source,
GridRegion  destination,
AgentCircuitData  aCircuit,
uint  flags,
EntityTransferContext  ctx,
out string  reason 
)

Ask the simulator hosting the destination to create an agent on that region.

Parameters
sourceThe region that the user is coming from. Will be null if the user logged-in directly, or arrived from a simulator that doesn't send this parameter.
destination
aCircuit
flags
reasonReason message in the event of a failure.

Implemented in OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule, OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule, and OpenSim.Services.Connectors.Simulation.SimulationServiceConnector.

bool OpenSim.Services.Interfaces.ISimulationService.CreateObject ( GridRegion  destination,
Vector3  newPosition,
ISceneObject  sog,
bool  isLocalCall 
)

Create an object in the destination region. This message is used primarily for prim crossing.

Parameters
regionHandle
sog
isLocalCall
Returns

Implemented in OpenSim.Services.Connectors.Simulation.SimulationServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule, and OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.

ISimulationService OpenSim.Services.Interfaces.ISimulationService.GetInnerService ( )
IScene OpenSim.Services.Interfaces.ISimulationService.GetScene ( UUID  regionId)
bool OpenSim.Services.Interfaces.ISimulationService.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.

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

Implemented in OpenSim.Services.Connectors.Simulation.SimulationServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule, and OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.

Here is the caller graph for this function:

bool OpenSim.Services.Interfaces.ISimulationService.ReleaseAgent ( UUID  originRegion,
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.

Parameters
regionHandle
id
uri
Returns

Implemented in OpenSim.Services.Connectors.Simulation.SimulationServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.LocalSimulationConnectorModule, and OpenSim.Region.CoreModules.ServiceConnectorsOut.Simulation.RemoteSimulationConnectorModule.

bool OpenSim.Services.Interfaces.ISimulationService.UpdateAgent ( GridRegion  destination,
AgentData  data,
EntityTransferContext  ctx 
)
bool OpenSim.Services.Interfaces.ISimulationService.UpdateAgent ( GridRegion  destination,
AgentPosition  data 
)

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