This class is used to send response data from OnMessageReceived event handlers back to Iguana.

Unit
IGC

Declaration
IIGCdestinationMessageReceivedEventOutputs = interface

Description

Destination plugins are provided with an instance of this class as an argument to their OnMessageReceived 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 MessageProcessedFlag property to true to indicate to Iguana that the message was received and processed by the plugin. Setting this property to false will simply result in Iguana logging a generic error message; it will not result in Iguana resending the message or stopping the channel. Plugins can achieve more sophisticated and precise error handling using the properties and methods described below.

If the event handler is unable to complete processing in a timely fashion, it should use the ResendMessageFlag and ResendMessageDelay properties to request that Iguana resend the message. This ensures that Iguana does not time-out the connection to the plugin due to inactivity. The exact duration of the time-out is determined by the Plugin Time field value configured for the To Plugin channel component to which the plugin is connected.

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

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