OpenSim.Services.Interfaces.IGridService Interface Reference

Inheritance diagram for OpenSim.Services.Interfaces.IGridService:

Public Member Functions
string	RegisterRegion (UUID scopeID, GridRegion regionInfos)
	Register a region with the grid service. More...
bool	DeregisterRegion (UUID regionID)
	Deregister a region with the grid service. More...
List< GridRegion >	GetNeighbours (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< GridRegion >	GetRegionsByName (UUID scopeID, string name, int maxNumber)
	Get information about regions starting with the provided name. More...
List< GridRegion >	GetRegionRange (UUID scopeID, int xmin, int xmax, int ymin, int ymax)
List< GridRegion >	GetDefaultRegions (UUID scopeID)
List< GridRegion >	GetDefaultHypergridRegions (UUID scopeID)
List< GridRegion >	GetFallbackRegions (UUID scopeID, int x, int y)
List< GridRegion >	GetHyperlinks (UUID scopeID)
int	GetRegionFlags (UUID scopeID, UUID regionID)
	Get internal OpenSimulator region flags. More...
Dictionary< string, object >	GetExtraFeatures ()

Detailed Description

Definition at line 42 of file IGridService.cs.

Member Function Documentation

bool OpenSim.Services.Interfaces.IGridService.DeregisterRegion

(

UUID

regionID

)

Deregister a region with the grid service.

Parameters

regionID

Returns

Exceptions

System.Exception

Thrown if region deregistration failed

Implemented in OpenSim.Services.GridService.GridService, OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.RemoteGridServicesConnector, OpenSim.Services.Connectors.GridServicesConnector, and OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.

List<GridRegion> OpenSim.Services.Interfaces.IGridService.GetDefaultHypergridRegions

(

UUID

scopeID

)

Implemented in OpenSim.Services.GridService.GridService, OpenSim.Services.Connectors.GridServicesConnector, OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.RemoteGridServicesConnector, and OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.

List<GridRegion> OpenSim.Services.Interfaces.IGridService.GetDefaultRegions

(

UUID

scopeID

)

Implemented in OpenSim.Services.GridService.GridService, OpenSim.Services.Connectors.GridServicesConnector, OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.RemoteGridServicesConnector, and OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.

Dictionary<string,object> OpenSim.Services.Interfaces.IGridService.GetExtraFeatures

(

)

Implemented in OpenSim.Services.GridService.GridService, OpenSim.Services.Connectors.GridServicesConnector, OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.RemoteGridServicesConnector, and OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.

List<GridRegion> OpenSim.Services.Interfaces.IGridService.GetFallbackRegions	(	UUID	scopeID,
		int	x,
		int	y
	)

Implemented in OpenSim.Services.GridService.GridService, OpenSim.Services.Connectors.GridServicesConnector, OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.RemoteGridServicesConnector, and OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.

List<GridRegion> OpenSim.Services.Interfaces.IGridService.GetHyperlinks

(

UUID

scopeID

)

Implemented in OpenSim.Services.GridService.GridService, OpenSim.Services.Connectors.GridServicesConnector, OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.RemoteGridServicesConnector, and OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.

List<GridRegion> OpenSim.Services.Interfaces.IGridService.GetNeighbours	(	UUID	scopeID,
		UUID	regionID
	)

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

Parameters

x
y

Returns

Implemented in OpenSim.Services.GridService.GridService, OpenSim.Services.Connectors.GridServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.RemoteGridServicesConnector, and OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector.

GridRegion OpenSim.Services.Interfaces.IGridService.GetRegionByName	(	UUID	scopeID,
		string	regionName
	)

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.

Implemented in OpenSim.Services.GridService.GridService, OpenSim.Services.Connectors.GridServicesConnector, OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector, and OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.RemoteGridServicesConnector.

GridRegion OpenSim.Services.Interfaces.IGridService.GetRegionByPosition	(	UUID	scopeID,
		int	x,
		int	y
	)

Get the region at the given position (in meters)

Parameters

scopeID
x
y

Returns

Implemented in OpenSim.Services.GridService.GridService, OpenSim.Services.Connectors.GridServicesConnector, OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector, and OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.RemoteGridServicesConnector.

GridRegion OpenSim.Services.Interfaces.IGridService.GetRegionByUUID	(	UUID	scopeID,
		UUID	regionID
	)

Implemented in OpenSim.Services.GridService.GridService, OpenSim.Services.Connectors.GridServicesConnector, OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector, and OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.RemoteGridServicesConnector.

int OpenSim.Services.Interfaces.IGridService.GetRegionFlags	(	UUID	scopeID,
		UUID	regionID
	)

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

Implemented in OpenSim.Services.GridService.GridService, OpenSim.Services.Connectors.GridServicesConnector, OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.RemoteGridServicesConnector, and OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.

List<GridRegion> OpenSim.Services.Interfaces.IGridService.GetRegionRange	(	UUID	scopeID,
		int	xmin,
		int	xmax,
		int	ymin,
		int	ymax
	)

Implemented in OpenSim.Services.GridService.GridService, OpenSim.Services.Connectors.GridServicesConnector, OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.RemoteGridServicesConnector, and OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.

List<GridRegion> OpenSim.Services.Interfaces.IGridService.GetRegionsByName	(	UUID	scopeID,
		string	name,
		int	maxNumber
	)

Get information about regions starting with the provided name.

Parameters

name	The name to match against.
maxNumber	The 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.

Implemented in OpenSim.Services.GridService.GridService, OpenSim.Services.Connectors.GridServicesConnector, OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector, and OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.RemoteGridServicesConnector.

string OpenSim.Services.Interfaces.IGridService.RegisterRegion	(	UUID	scopeID,
		GridRegion	regionInfos
	)

Register a region with the grid service.

Parameters

regionInfos

Returns

Exceptions

System.Exception

Thrown if region registration failed

Implemented in OpenSim.Services.GridService.GridService, OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector, OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.RemoteGridServicesConnector, OpenSim.Services.Connectors.SimianGrid.SimianGridServiceConnector, and OpenSim.Services.Connectors.GridServicesConnector.

---

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

• Services/Interfaces/IGridService.cs