Connects avatar presence information (for tracking current location and message routing) to the SimianGrid backend More...

Inheritance diagram for OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector:

[legend]

Collaboration diagram for OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector:

[legend]

Public Member Functions
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...

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

	SimianPresenceServiceConnector ()

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

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

bool	LoginAgent (string userID, UUID sessionID, UUID secureSessionID)
	Store session information. More...

bool	LogoutAgent (UUID sessionID)
	Remove session information. More...

bool	LogoutRegionAgents (UUID regionID)
	Remove session information for all agents in the given region. More...

bool	ReportAgent (UUID sessionID, UUID regionID)
	Update data for an existing session. More...

PresenceInfo	GetAgent (UUID sessionID)
	Get session information for a given session ID. More...

PresenceInfo[]	GetAgents (string[] userIDs)
	Get session information for a collection of users. More...

GridUserInfo	LoggedIn (string userID)

bool	LoggedOut (string userID, UUID sessionID, UUID regionID, Vector3 lastPosition, Vector3 lastLookAt)
	Informs the grid that a user is logged out and to remove any session data for them More...

bool	SetHome (string userID, UUID regionID, Vector3 position, Vector3 lookAt)

bool	SetLastPosition (string userID, UUID sessionID, UUID regionID, Vector3 lastPosition, Vector3 lastLookAt)
	Stores the last known user position at the grid level More...

GridUserInfo	GetGridUserInfo (string user)

GridUserInfo[]	GetGridUserInfo (string[] userIDs)

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

Connects avatar presence information (for tracking current location and message routing) to the SimianGrid backend

Definition at line 51 of file SimianPresenceServiceConnector.cs.

Constructor & Destructor Documentation

OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.SimianPresenceServiceConnector ( )

inline

Definition at line 68 of file SimianPresenceServiceConnector.cs.

OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.SimianPresenceServiceConnector ( IConfigSource source )

inline

Definition at line 97 of file SimianPresenceServiceConnector.cs.

Member Function Documentation

void OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.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 70 of file SimianPresenceServiceConnector.cs.

void OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.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 66 of file SimianPresenceServiceConnector.cs.

PresenceInfo OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.GetAgent ( UUID sessionID )

inline

Get session information for a given session ID.

Returns

Parameters

sessionID

Implements OpenSim.Services.Interfaces.IPresenceService.

Definition at line 205 of file SimianPresenceServiceConnector.cs.

PresenceInfo [] OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.GetAgents ( string[] userIDs )

inline

Get session information for a collection of users.

Returns: Session information for the users.

Parameters

userIDs

Implements OpenSim.Services.Interfaces.IPresenceService.

Definition at line 225 of file SimianPresenceServiceConnector.cs.

GridUserInfo OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.GetGridUserInfo ( string user )

inline

Implements OpenSim.Services.Interfaces.IGridUserService.

Definition at line 312 of file SimianPresenceServiceConnector.cs.

GridUserInfo [] OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.GetGridUserInfo ( string[] userIDs )

inline

Implements OpenSim.Services.Interfaces.IGridUserService.

Definition at line 453 of file SimianPresenceServiceConnector.cs.

void OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.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 102 of file SimianPresenceServiceConnector.cs.

GridUserInfo OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.LoggedIn ( string userID )

inline

Implements OpenSim.Services.Interfaces.IGridUserService.

Definition at line 256 of file SimianPresenceServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.LoggedOut	(	string	userID,
		UUID	sessionID,
		UUID	regionID,
		Vector3	lastPosition,
		Vector3	lastLookAt
	)

inline

Informs the grid that a user is logged out and to remove any session data for them

Parameters

userID	Ignore if your connector does not use userID for logouts
sessionID	Ignore if your connector does not use sessionID for logouts
regionID	RegionID where the user was last located
lastPosition	Last region-relative position of the user
lastLookAt	Last normalized look direction for the user

Returns: True if the logout request was successfully processed, otherwise false

Implements OpenSim.Services.Interfaces.IGridUserService.

Definition at line 262 of file SimianPresenceServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.LoginAgent	(	string	userID,
		UUID	sessionID,
		UUID	secureSessionID
	)

inline

Store session information.

Returns

/returns>

Parameters

userID
sessionID
secureSessionID

Implements OpenSim.Services.Interfaces.IPresenceService.

Definition at line 135 of file SimianPresenceServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.LogoutAgent ( UUID sessionID )

inline

Remove session information.

Returns

Parameters

sessionID

Implements OpenSim.Services.Interfaces.IPresenceService.

Definition at line 161 of file SimianPresenceServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.LogoutRegionAgents ( UUID regionID )

inline

Remove session information for all agents in the given region.

Returns

Parameters

regionID

Implements OpenSim.Services.Interfaces.IPresenceService.

Definition at line 180 of file SimianPresenceServiceConnector.cs.

void OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.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 65 of file SimianPresenceServiceConnector.cs.

void OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.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 64 of file SimianPresenceServiceConnector.cs.

void OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.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 82 of file SimianPresenceServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.ReportAgent	(	UUID	sessionID,
		UUID	regionID
	)

inline

Update data for an existing session.

Returns

Parameters

sessionID
regionID

Implements OpenSim.Services.Interfaces.IPresenceService.

Definition at line 199 of file SimianPresenceServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.SetHome	(	string	userID,
		UUID	regionID,
		Vector3	position,
		Vector3	lookAt
	)

inline

Implements OpenSim.Services.Interfaces.IGridUserService.

Definition at line 287 of file SimianPresenceServiceConnector.cs.

bool OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.SetLastPosition	(	string	userID,
		UUID	sessionID,
		UUID	regionID,
		Vector3	lastPosition,
		Vector3	lastLookAt
	)

inline

Stores the last known user position at the grid level

Parameters

userID	Ignore if your connector does not use userID for position updates
sessionID	Ignore if your connector does not use sessionID for position updates
regionID	RegionID where the user is currently located
lastPosition	Region-relative position
lastLookAt	Normalized look direction

Returns: True if the user's last position was successfully updated, otherwise false

Implements OpenSim.Services.Interfaces.IGridUserService.

Definition at line 307 of file SimianPresenceServiceConnector.cs.

Property Documentation

string OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.Name

get

Definition at line 69 of file SimianPresenceServiceConnector.cs.

Type OpenSim.Services.Connectors.SimianGrid.SimianPresenceServiceConnector.ReplaceableInterface

get

Definition at line 63 of file SimianPresenceServiceConnector.cs.

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

Services/Connectors/SimianGrid/SimianPresenceServiceConnector.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation