OpenSim.Region.Framework.Interfaces.IMessageTransferModule Interface Reference

Inheritance diagram for OpenSim.Region.Framework.Interfaces.IMessageTransferModule:

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

Events
UndeliveredMessage	OnUndeliveredMessage

Detailed Description

Definition at line 35 of file IMessageTransferModule.cs.

Member Function Documentation

void OpenSim.Region.Framework.Interfaces.IMessageTransferModule.HandleUndeliverableMessage	(	GridInstantMessage	im,
		MessageResultNotification	result
	)

Appropriately handle a known undeliverable message without attempting a send.

Essentially, this invokes the OnUndeliveredMessage event.

Parameters

im
result

Implemented in OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule, and OpenSim.Region.CoreModules.Avatar.InstantMessage.MessageTransferModule.

void OpenSim.Region.Framework.Interfaces.IMessageTransferModule.SendInstantMessage	(	GridInstantMessage	im,
		MessageResultNotification	result
	)

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

Implemented in OpenSim.Region.CoreModules.Avatar.InstantMessage.HGMessageTransferModule, and OpenSim.Region.CoreModules.Avatar.InstantMessage.MessageTransferModule.

Event Documentation

UndeliveredMessage OpenSim.Region.Framework.Interfaces.IMessageTransferModule.OnUndeliveredMessage

Definition at line 37 of file IMessageTransferModule.cs.

---

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

• Region/Framework/Interfaces/IMessageTransferModule.cs