Class Hierarchy   Class Index   Method Index  

IGCsourceMessageRequestCompletedEventInputs Class Reference

#include <IGCsourceMessageRequestCompletedEventInputs.h>

Detailed Description

This class is used to pass data from Iguana to IGCsource::OnMessageRequestCompleted event handlers.


Public Member Functions

 IGCsourceMessageRequestCompletedEventInputs ()
 Constructor.
virtual ~IGCsourceMessageRequestCompletedEventInputs ()
 Destructor.
IGCsourceMessageRequestCompletedEventInputs & operator= (const IGCsourceMessageRequestCompletedEventInputs &Orig)
 Assignment operator.
IGCsourceMessageRequestCompletedEventInputsHandle GetHandle () const
 This method is part of the internal implementation of this class and should not be called.
const char * PluginMessageId () const
 Id assigned by the plugin's IGCsource::OnMessageRequested event handler via the IGCsourceMessageRequestedEventOutputs::PluginMessageId property.
const char * MessageLogId () const
 Id assigned by Iguana uniquely identifying the generated message within Iguana's logs.
IGCboolean MessageProcessed () const
 Flag indicating whether or not message was processed by Iguana.

Constructor & Destructor Documentation

IGCsourceMessageRequestCompletedEventInputs::IGCsourceMessageRequestCompletedEventInputs (   ) 
 

Constructor.

virtual IGCsourceMessageRequestCompletedEventInputs::~IGCsourceMessageRequestCompletedEventInputs (   )  [virtual]
 

Destructor.

Member Function Documentation

IGCsourceMessageRequestCompletedEventInputsHandle IGCsourceMessageRequestCompletedEventInputs::GetHandle (   )  const [inline]
 

This method is part of the internal implementation of this class and should not be called.

const char* IGCsourceMessageRequestCompletedEventInputs::MessageLogId (   )  const
 

Id assigned by Iguana uniquely identifying the generated message within Iguana's logs.

The Message Log Id may be used to query Iguana for additional message-related information.

See

http://www.interfaceware.com/manual/iguana4_using_message_id.html

IGCboolean IGCsourceMessageRequestCompletedEventInputs::MessageProcessed (   )  const
 

Flag indicating whether or not message was processed by Iguana.

If true, the message has been processed by Iguana and does not need to be resent. The plugin should respond to the next IGCsource::OnMessageRequested event with the next available message.

If false, the message has not been processed by Iguana and needs to be resent. The plugin should respond to the next IGCsource::OnMessageRequested event with the same message.

IGCsourceMessageRequestCompletedEventInputs& IGCsourceMessageRequestCompletedEventInputs::operator= (  const IGCsourceMessageRequestCompletedEventInputs &  Orig  ) 
 

Assignment operator.

const char* IGCsourceMessageRequestCompletedEventInputs::PluginMessageId (   )  const
 

Id assigned by the plugin's IGCsource::OnMessageRequested event handler via the IGCsourceMessageRequestedEventOutputs::PluginMessageId property.

This allows the plugin to associate each message request completed notification with the message sent to Iguana.

The format of the PluginMessageId is to be determined by the plugin author. Iguana does not interpret this value, other than by adding it to logs, and sending it back to the plugin.

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