Inheritance diagram for OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule:

Collaboration diagram for OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule:

Public Member Functions
virtual void	Initialise (IConfigSource config)
	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...

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

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

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

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

virtual void	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...

void	SendInstantMessage (GridInstantMessage im, MessageResultNotification result)
	Attempt to send an instant message to a given destination. More...

void	HandleUndeliverableMessage (GridInstantMessage im, MessageResultNotification result)
	Appropriately handle a known undeliverable message without attempting a send. More...

IClientAPI	LocateClientObject (UUID agentID)
	Find the root client for a ID More...

bool	SendInstantMessage (GridInstantMessage im)

Protected Member Functions
bool	SendIMToScene (GridInstantMessage gim, UUID toAgentID)

Protected Attributes
bool	m_Enabled = false

List< Scene >	m_Scenes = new List<Scene>()

IInstantMessage	m_IMService

Dictionary< UUID, object >	m_UserLocationMap = new Dictionary<UUID, object>()

Properties
virtual string	Name `[get]`

virtual Type	ReplaceableInterface `[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...

Events
UndeliveredMessage	OnUndeliveredMessage

Events inherited from OpenSim.Region.Framework.Interfaces.IMessageTransferModule
UndeliveredMessage	OnUndeliveredMessage

Detailed Description

Definition at line 52 of file HGMessageTransferModule.cs.

Member Function Documentation

virtual void OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.AddRegion ( Scene scene )

inlinevirtual

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 90 of file HGMessageTransferModule.cs.

virtual void OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.Close ( )

inlinevirtual

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 125 of file HGMessageTransferModule.cs.

void OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.HandleUndeliverableMessage	(	GridInstantMessage	im,
		MessageResultNotification	result
	)

inline

Appropriately handle a known undeliverable message without attempting a send.

Essentially, this invokes the OnUndeliveredMessage event.

Parameters

im
result

Implements OpenSim.Region.Framework.Interfaces.IMessageTransferModule.

Definition at line 249 of file HGMessageTransferModule.cs.

Here is the call graph for this function:

virtual void OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.Initialise ( IConfigSource source )

inlinevirtual

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 75 of file HGMessageTransferModule.cs.

IClientAPI OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.LocateClientObject ( UUID agentID )

inline

Find the root client for a ID

Definition at line 306 of file HGMessageTransferModule.cs.

virtual void OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.PostInitialise ( )

inlinevirtual

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 103 of file HGMessageTransferModule.cs.

virtual void OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.RegionLoaded ( Scene scene )

inlinevirtual

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 110 of file HGMessageTransferModule.cs.

virtual void OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.RemoveRegion ( Scene scene )

inlinevirtual

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 114 of file HGMessageTransferModule.cs.

bool OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.SendIMToScene	(	GridInstantMessage	gim,
		UUID	toAgentID
	)

inlineprotected

Definition at line 221 of file HGMessageTransferModule.cs.

void OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.SendInstantMessage	(	GridInstantMessage	im,
		MessageResultNotification	result
	)

inline

Attempt to send an instant message to a given destination.

If the message cannot be delivered for any reason, this will be signalled on the OnUndeliveredMessage event. result(false) will also be called if the message cannot be delievered unless the type is InstantMessageDialog.MessageFromAgent. For successful message delivery, result(true) is called.

Parameters

im
result

Implements OpenSim.Region.Framework.Interfaces.IMessageTransferModule.

Definition at line 139 of file HGMessageTransferModule.cs.

bool OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.SendInstantMessage ( GridInstantMessage im )

inline

Implements OpenSim.Services.Interfaces.IInstantMessageSimConnector.

Definition at line 322 of file HGMessageTransferModule.cs.

Member Data Documentation

bool OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.m_Enabled = false

protected

Definition at line 56 of file HGMessageTransferModule.cs.

IInstantMessage OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.m_IMService

protected

Definition at line 59 of file HGMessageTransferModule.cs.

List<Scene> OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.m_Scenes = new List<Scene>()

protected

Definition at line 57 of file HGMessageTransferModule.cs.

Dictionary<UUID, object> OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.m_UserLocationMap = new Dictionary<UUID, object>()

protected

Definition at line 60 of file HGMessageTransferModule.cs.

Property Documentation

virtual string OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.Name

get

Definition at line 130 of file HGMessageTransferModule.cs.

virtual Type OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.ReplaceableInterface

get

Definition at line 135 of file HGMessageTransferModule.cs.

Event Documentation

UndeliveredMessage OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule.OnUndeliveredMessage

Definition at line 62 of file HGMessageTransferModule.cs.

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

Region/CoreModules/Avatar/InstantMessage/HGMessageTransferModule.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Events

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation

Event Documentation