Inheritance diagram for OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector:

Collaboration diagram for OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector:

Public Member Functions
	LocalGridServicesConnector ()

	LocalGridServicesConnector (IConfigSource source)

void	Initialise (IConfigSource source)
	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...

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

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

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< 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 ()

void	HandleShowNeighboursCommand (string module, string[] cmdparams)

Properties
Type	ReplaceableInterface `[get]`

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 46 of file LocalGridServiceConnector.cs.

Constructor & Destructor Documentation

OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.LocalGridServicesConnector ( )

inline

Definition at line 58 of file LocalGridServiceConnector.cs.

OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.LocalGridServicesConnector ( IConfigSource source )

inline

Definition at line 63 of file LocalGridServiceConnector.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.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 139 of file LocalGridServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.Close ( )

inline

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 135 of file LocalGridServiceConnector.cs.

bool OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.DeregisterRegion ( UUID regionID )

inline

Deregister a region with the grid service.

Parameters

regionID

Returns

Exceptions

System.Exception Thrown if region deregistration failed

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 180 of file LocalGridServiceConnector.cs.

List<GridRegion> OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.GetDefaultHypergridRegions ( UUID scopeID )

inline

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 263 of file LocalGridServiceConnector.cs.

List<GridRegion> OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.GetDefaultRegions ( UUID scopeID )

inline

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 258 of file LocalGridServiceConnector.cs.

Dictionary<string, object> OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.GetExtraFeatures ( )

inline

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 283 of file LocalGridServiceConnector.cs.

List<GridRegion> OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.GetFallbackRegions	(	UUID	scopeID,
		int	x,
		int	y
	)

inline

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 268 of file LocalGridServiceConnector.cs.

List<GridRegion> OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.GetHyperlinks ( UUID scopeID )

inline

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 273 of file LocalGridServiceConnector.cs.

List<GridRegion> OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.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 185 of file LocalGridServiceConnector.cs.

GridRegion OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.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 243 of file LocalGridServiceConnector.cs.

GridRegion OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.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 198 of file LocalGridServiceConnector.cs.

GridRegion OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.GetRegionByUUID	(	UUID	scopeID,
		UUID	regionID
	)

inline

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 190 of file LocalGridServiceConnector.cs.

int OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.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 278 of file LocalGridServiceConnector.cs.

List<GridRegion> OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.GetRegionRange	(	UUID	scopeID,
		int	xmin,
		int	xmax,
		int	ymin,
		int	ymax
	)

inline

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 253 of file LocalGridServiceConnector.cs.

List<GridRegion> OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.GetRegionsByName	(	UUID	scopeID,
		string	name,
		int	maxNumber
	)

inline

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.

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 248 of file LocalGridServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.HandleShowNeighboursCommand	(	string	module,
		string[]	cmdparams
	)

inline

Definition at line 290 of file LocalGridServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.Initialise ( IConfigSource source )

inline

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 81 of file LocalGridServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.PostInitialise ( )

inline

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 126 of file LocalGridServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.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 167 of file LocalGridServiceConnector.cs.

string OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.RegisterRegion	(	UUID	scopeID,
		GridRegion	regionInfos
	)

inline

Register a region with the grid service.

Parameters

regionInfos

Returns

Exceptions

System.Exception Thrown if region registration failed

Implements OpenSim.Services.Interfaces.IGridService.

Definition at line 175 of file LocalGridServiceConnector.cs.

void OpenSim.Region.CoreModules.ServiceConnectorsOut.Grid.LocalGridServicesConnector.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 155 of file LocalGridServiceConnector.cs.