Class Hierarchy   Class Index   Method Index  

IGCsourceMessageRequestedEventOutputs Class Reference

#include <IGCsourceMessageRequestedEventOutputs.h>

Detailed Description

This class is used to send response data from IGCsource::OnMessageRequested event handlers back to Iguana.

Source plugins are provided with an instance of this class as an argument to their IGCsource::OnMessageRequested event handler. The event handler uses the properties and methods of the provided instance to craft a suitable response to send back to Iguana. After the event handler returns, the response is sent back to Iguana.

At a minimum, the event handler should set the IGCsourceMessageRequestedEventOutputs::OutboundMessage and IGCsourceMessageRequestedEventOutputs::PluginMessageId properties to appropriate values.

The plugin event handler may request that the Iguana channel be stopped via the IGCsourceMessageRequestedEventOutputs::StopChannelFlag, IGCsourceMessageRequestedEventOutputs::StopChannelErrorFlag and IGCsourceMessageRequestedEventOutputs::StopChannelReason properties.

The plugin event handler may add log messages to Iguana's logs using the IGCsourceMessageRequestedEventOutputs::AddErrorLogMessage, IGCsourceMessageRequestedEventOutputs::AddWarningLogMessage, IGCsourceMessageRequestedEventOutputs::AddInfoLogMessage and IGCsourceMessageRequestedEventOutputs::AddDebugLogMessage methods.


Public Member Functions

 IGCsourceMessageRequestedEventOutputs ()
 Constructor.
virtual ~IGCsourceMessageRequestedEventOutputs ()
 Destructor.
IGCsourceMessageRequestedEventOutputs & operator= (const IGCsourceMessageRequestedEventOutputs &Orig)
 Assignment operator.
IGCsourceMessageRequestedEventOutputsHandle GetHandle () const
 This method is part of the internal implementation of this class and should not be called.
const char * OutboundMessage () const
 Message to send back to Iguana, or an empty string if a message is not presently available.
void SetOutboundMessage (const char *Value)
 Set method for OutboundMessage.
const char * PluginMessageId () const
 Id to be assigned by the plugin to uniquely identify IGCsourceMessageRequestedEventOutputs::OutboundMessage.
void SetPluginMessageId (const char *Value)
 Set method for PluginMessageId.
IGCboolean StopChannelFlag () const
 Requests that Iguana stop the channel to which the plugin is connected.
void SetStopChannelFlag (IGCboolean Value)
 Set method for StopChannelFlag.
IGCboolean StopChannelErrorFlag () const
 When combined with IGCsourceMessageRequestedEventOutputs::StopChannelFlag, requests that Iguana stop the channel with the channel status set to 'error'.
void SetStopChannelErrorFlag (IGCboolean Value)
 Set method for StopChannelErrorFlag.
const char * StopChannelReason () const
 Describes the reason for the 'stop channel' request.
void SetStopChannelReason (const char *Value)
 Set method for StopChannelReason.
void AddErrorLogMessage (const char *ErrorLogMessage)
 Adds an error log message to Iguana's logs.
void AddWarningLogMessage (const char *WarningLogMessage)
 Adds a warning log message to Iguana's logs.
void AddInfoLogMessage (const char *InfoLogMessage)
 Adds an info log message to Iguana's logs.
void AddDebugLogMessage (const char *DebugLogMessage)
 Adds a debug log message to Iguana's logs.

Constructor & Destructor Documentation

IGCsourceMessageRequestedEventOutputs::IGCsourceMessageRequestedEventOutputs (   ) 
 

Constructor.

virtual IGCsourceMessageRequestedEventOutputs::~IGCsourceMessageRequestedEventOutputs (   )  [virtual]
 

Destructor.

Member Function Documentation

void IGCsourceMessageRequestedEventOutputs::AddDebugLogMessage (  const char *  DebugLogMessage  ) 
 

Adds a debug log message to Iguana's logs.

Parameters:
DebugLogMessage Log message text.

void IGCsourceMessageRequestedEventOutputs::AddErrorLogMessage (  const char *  ErrorLogMessage  ) 
 

Adds an error log message to Iguana's logs.

Parameters:
ErrorLogMessage Log message text.

void IGCsourceMessageRequestedEventOutputs::AddInfoLogMessage (  const char *  InfoLogMessage  ) 
 

Adds an info log message to Iguana's logs.

Parameters:
InfoLogMessage Log message text.

void IGCsourceMessageRequestedEventOutputs::AddWarningLogMessage (  const char *  WarningLogMessage  ) 
 

Adds a warning log message to Iguana's logs.

Parameters:
WarningLogMessage Log message text.

IGCsourceMessageRequestedEventOutputsHandle IGCsourceMessageRequestedEventOutputs::GetHandle (   )  const [inline]
 

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

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

Assignment operator.

const char* IGCsourceMessageRequestedEventOutputs::OutboundMessage (   )  const
 

Message to send back to Iguana, or an empty string if a message is not presently available.

See also the IGCsourceMessageRequestedEventOutputs::SetOutboundMessage method.

const char* IGCsourceMessageRequestedEventOutputs::PluginMessageId (   )  const
 

Id to be assigned by the plugin to uniquely identify IGCsourceMessageRequestedEventOutputs::OutboundMessage.

Iguana sends the provided PluginMessageId back to the plugin's IGCsource::OnMessageRequestCompleted event handler via IGCsourceMessageRequestCompletedEventInputs::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.

See also the IGCsourceMessageRequestedEventOutputs::SetPluginMessageId method.

void IGCsourceMessageRequestedEventOutputs::SetOutboundMessage (  const char *  Value  ) 
 

Set method for OutboundMessage.

See IGCsourceMessageRequestedEventOutputs::OutboundMessage.

Parameters:
Value Value to set OutboundMessage to.

void IGCsourceMessageRequestedEventOutputs::SetPluginMessageId (  const char *  Value  ) 
 

Set method for PluginMessageId.

See IGCsourceMessageRequestedEventOutputs::PluginMessageId.

Parameters:
Value Value to set PluginMessageId to.

void IGCsourceMessageRequestedEventOutputs::SetStopChannelErrorFlag (  IGCboolean  Value  ) 
 

Set method for StopChannelErrorFlag.

See IGCsourceMessageRequestedEventOutputs::StopChannelErrorFlag.

Parameters:
Value Value to set StopChannelErrorFlag to.

void IGCsourceMessageRequestedEventOutputs::SetStopChannelFlag (  IGCboolean  Value  ) 
 

Set method for StopChannelFlag.

See IGCsourceMessageRequestedEventOutputs::StopChannelFlag.

Parameters:
Value Value to set StopChannelFlag to.

void IGCsourceMessageRequestedEventOutputs::SetStopChannelReason (  const char *  Value  ) 
 

Set method for StopChannelReason.

See IGCsourceMessageRequestedEventOutputs::StopChannelReason.

Parameters:
Value Value to set StopChannelReason to.

IGCboolean IGCsourceMessageRequestedEventOutputs::StopChannelErrorFlag (   )  const
 

When combined with IGCsourceMessageRequestedEventOutputs::StopChannelFlag, requests that Iguana stop the channel with the channel status set to 'error'.

Default value: false.

Only applicable if IGCsourceMessageRequestedEventOutputs::StopChannelFlag is set to true.

See also the IGCsourceMessageRequestedEventOutputs::SetStopChannelErrorFlag method.

IGCboolean IGCsourceMessageRequestedEventOutputs::StopChannelFlag (   )  const
 

Requests that Iguana stop the channel to which the plugin is connected.

Default value: false.

See also: IGCsourceMessageRequestedEventOutputs::StopChannelErrorFlag and IGCsourceMessageRequestedEventOutputs::StopChannelReason.

See also the IGCsourceMessageRequestedEventOutputs::SetStopChannelFlag method.

const char* IGCsourceMessageRequestedEventOutputs::StopChannelReason (   )  const
 

Describes the reason for the 'stop channel' request.

Only applicable if IGCsourceMessageRequestedEventOutputs::StopChannelFlag is set to true.

See also the IGCsourceMessageRequestedEventOutputs::SetStopChannelReason method.

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