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

Public Member Functions

 GridServicesConnector ()
 
 GridServicesConnector (string serverURI)
 
 GridServicesConnector (IConfigSource source)
 
virtual 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 ()
 
- Public Member Functions inherited from OpenSim.Services.Connectors.BaseServiceConnector
 BaseServiceConnector ()
 
 BaseServiceConnector (IConfigSource config, string section)
 
void Initialise (IConfigSource config, string section)
 

Additional Inherited Members

- Protected Attributes inherited from OpenSim.Services.Connectors.BaseServiceConnector
IServiceAuth m_Auth
 

Detailed Description

Definition at line 44 of file GridServicesConnector.cs.

Constructor & Destructor Documentation

OpenSim.Services.Connectors.GridServicesConnector.GridServicesConnector ( )
inline

Definition at line 55 of file GridServicesConnector.cs.

OpenSim.Services.Connectors.GridServicesConnector.GridServicesConnector ( string  serverURI)
inline

Definition at line 59 of file GridServicesConnector.cs.

OpenSim.Services.Connectors.GridServicesConnector.GridServicesConnector ( IConfigSource  source)
inline

Definition at line 64 of file GridServicesConnector.cs.

Member Function Documentation

bool OpenSim.Services.Connectors.GridServicesConnector.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 154 of file GridServicesConnector.cs.

List<GridRegion> OpenSim.Services.Connectors.GridServicesConnector.GetDefaultHypergridRegions ( UUID  scopeID)
inline
List<GridRegion> OpenSim.Services.Connectors.GridServicesConnector.GetDefaultRegions ( UUID  scopeID)
inline
Dictionary<string, object> OpenSim.Services.Connectors.GridServicesConnector.GetExtraFeatures ( )
inline
List<GridRegion> OpenSim.Services.Connectors.GridServicesConnector.GetFallbackRegions ( UUID  scopeID,
int  x,
int  y 
)
inline
List<GridRegion> OpenSim.Services.Connectors.GridServicesConnector.GetHyperlinks ( UUID  scopeID)
inline
List<GridRegion> OpenSim.Services.Connectors.GridServicesConnector.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 187 of file GridServicesConnector.cs.

GridRegion OpenSim.Services.Connectors.GridServicesConnector.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 332 of file GridServicesConnector.cs.

GridRegion OpenSim.Services.Connectors.GridServicesConnector.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 279 of file GridServicesConnector.cs.

GridRegion OpenSim.Services.Connectors.GridServicesConnector.GetRegionByUUID ( UUID  scopeID,
UUID  regionID 
)
inline
int OpenSim.Services.Connectors.GridServicesConnector.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 686 of file GridServicesConnector.cs.

List<GridRegion> OpenSim.Services.Connectors.GridServicesConnector.GetRegionRange ( UUID  scopeID,
int  xmin,
int  xmax,
int  ymin,
int  ymax 
)
inline
List<GridRegion> OpenSim.Services.Connectors.GridServicesConnector.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 374 of file GridServicesConnector.cs.

virtual void OpenSim.Services.Connectors.GridServicesConnector.Initialise ( IConfigSource  source)
inlinevirtual

Definition at line 69 of file GridServicesConnector.cs.

string OpenSim.Services.Connectors.GridServicesConnector.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 94 of file GridServicesConnector.cs.


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