[This is preliminary documentation and is subject to change.]
The base interface for all listener interfaces related to the exchange of
messages over the underlying messaging infrastructure. For example,
SIFMessagingListener extends this interface for the Schools Interoperability
Framework.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public interface IMessagingListener
Public Interface IMessagingListener
public interface class IMessagingListener
Members| All Members | Methods | ||||
| Icon | Member | Description |
|---|---|---|
 | OnMessageProcessed(SifMessageType, IMessageInfo) | Called when a message has been received by the framework and successfully
dispatched to the Adk's message handlers. If a message is received but
not processed by a message handler -- either because of an error or
because there is no Publisher, Subscriber, or QueryResults
message handler to handle it -- this method is never called.
|
| OnMessageReceived(SifMessageType, StringBuilder) | Called when a message has been received by the framework, before it is
dispatched to the Adk's message handlers.
An agent can implement this method to count the number of messages
received, to signal the user interface or other interested parties that
a message has arrived, to examine or change the raw content of incoming
messages before they're dispatched to the framework, or to prevent the
framework from dispatching messages to message handlers. When filtering
messages, return  CopyC#true CopyC#false |
| OnMessageSent(SifMessageType, IMessageInfo, Object) | Called when a message has been sent by the framework.
An agent can implement this method to count the number of messages
sent or to signal the user interface or other interested parties that a
message has been sent.
|
| OnSendingMessage(SifMessageType, IMessageInfo, StringBuilder) | Called when a message is about to be sent by the framework.
An agent can implement this method to filter outbound messages in order
to change the message content or prevent the framework from sending a
message to the server. When filtering messages, return CopyC#true CopyC#false |