OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | List of all members
OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector Class Reference

Connects region registration and neighbor lookups to the SimianGrid backend More...

Inheritance diagram for OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector:
Collaboration graph
[legend]

Public Member Functions

 SimianGridServiceConnector ()
 
 SimianGridServiceConnector (string serverURI)
 
 SimianGridServiceConnector (IConfigSource source)
 
void Initialise (IConfigSource source)
 
string RegisterRegion (UUID scopeID, GridRegion regionInfo)
 Register a region with the grid service. More...
 
bool DeregisterRegion (UUID regionID)
 Deregister a region with the grid service. More...
 
List< GridRegionGetNeighbours (UUID scopeID, UUID regionID)
 Get information about the regions neighbouring the given co-ordinates (in meters). More...
 
GridRegion GetRegionByUUID (UUID scopeID, UUID regionID)
 
GridRegion GetRegionByPosition (UUID scopeID, int x, int y)
 Get the region at the given position (in meters) More...
 
GridRegion GetRegionByName (UUID scopeID, string regionName)
 Get information about a region which exactly matches the name given. More...
 
List< GridRegionGetRegionsByName (UUID scopeID, string name, int maxNumber)
 Get information about regions starting with the provided name. More...
 
List< GridRegionGetRegionRange (UUID scopeID, int xmin, int xmax, int ymin, int ymax)
 
List< GridRegionGetDefaultRegions (UUID scopeID)
 
List< GridRegionGetDefaultHypergridRegions (UUID scopeID)
 
List< GridRegionGetFallbackRegions (UUID scopeID, int x, int y)
 
List< GridRegionGetHyperlinks (UUID scopeID)
 
int GetRegionFlags (UUID scopeID, UUID regionID)
 Get internal OpenSimulator region flags. More...
 
Dictionary< string, object > GetExtraFeatures ()
 

Detailed Description

Connects region registration and neighbor lookups to the SimianGrid backend

Definition at line 54 of file SimianGridServiceConnector.cs.

Constructor & Destructor Documentation

OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.SimianGridServiceConnector ( )
inline

Definition at line 63 of file SimianGridServiceConnector.cs.

OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.SimianGridServiceConnector ( string  serverURI)
inline

Definition at line 64 of file SimianGridServiceConnector.cs.

OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.SimianGridServiceConnector ( IConfigSource  source)
inline

Definition at line 69 of file SimianGridServiceConnector.cs.

Member Function Documentation

bool OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.DeregisterRegion ( UUID  regionID)
inline

Deregister a region with the grid service.

Parameters
regionID
Returns
Exceptions
System.ExceptionThrown if region deregistration failed

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 150 of file SimianGridServiceConnector.cs.

List<GridRegion> OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.GetDefaultHypergridRegions ( UUID  scopeID)
inline
List<GridRegion> OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.GetDefaultRegions ( UUID  scopeID)
inline
Dictionary<string, object> OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.GetExtraFeatures ( )
inline

See SimulatorFeaturesModule - Need to get map, search and destination guide

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 417 of file SimianGridServiceConnector.cs.

List<GridRegion> OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.GetFallbackRegions ( UUID  scopeID,
int  x,
int  y 
)
inline
List<GridRegion> OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.GetHyperlinks ( UUID  scopeID)
inline
List<GridRegion> OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.GetNeighbours ( UUID  scopeID,
UUID  regionID 
)
inline

Get information about the regions neighbouring the given co-ordinates (in meters).

Parameters
x
y
Returns

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 168 of file SimianGridServiceConnector.cs.

GridRegion OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.GetRegionByName ( UUID  scopeID,
string  regionName 
)
inline

Get information about a region which exactly matches the name given.

Parameters
scopeID
regionName
Returns
Returns the region information if the name matched. Null otherwise.

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 248 of file SimianGridServiceConnector.cs.

GridRegion OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.GetRegionByPosition ( UUID  scopeID,
int  x,
int  y 
)
inline

Get the region at the given position (in meters)

Parameters
scopeID
x
y
Returns

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 219 of file SimianGridServiceConnector.cs.

GridRegion OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.GetRegionByUUID ( UUID  scopeID,
UUID  regionID 
)
inline
int OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.GetRegionFlags ( UUID  scopeID,
UUID  regionID 
)
inline

Get internal OpenSimulator region flags.

See OpenSimulator.Framework.RegionFlags. These are not returned in the GridRegion structure - they currently need to be requested separately. Possibly this should change to avoid multiple service calls in some situations.

Returns
The region flags.
Parameters
scopeID
regionID

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 390 of file SimianGridServiceConnector.cs.

List<GridRegion> OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.GetRegionRange ( UUID  scopeID,
int  xmin,
int  xmax,
int  ymin,
int  ymax 
)
inline
List<GridRegion> OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.GetRegionsByName ( UUID  scopeID,
string  name,
int  maxNumber 
)
inline

Get information about regions starting with the provided name.

Parameters
nameThe name to match against.
maxNumberThe maximum number of results to return.
Returns
A list of RegionInfos of regions with matching name. If the grid-server couldn't be contacted or returned an error, return null.

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 260 of file SimianGridServiceConnector.cs.

void OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.Initialise ( IConfigSource  source)
inline

Definition at line 74 of file SimianGridServiceConnector.cs.

string OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.RegisterRegion ( UUID  scopeID,
GridRegion  regionInfos 
)
inline

Register a region with the grid service.

Parameters
regionInfos
Returns
Exceptions
System.ExceptionThrown if region registration failed

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 103 of file SimianGridServiceConnector.cs.


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