|
IIGCsourceMessageRequestedEventOutputs Interface Properties Methods |
This class is used to send response data from OnMessageRequested event handlers back to Iguana.
Unit
IGC
Declaration
IIGCsourceMessageRequestedEventOutputs = interface
Description
Source plugins are provided with an instance of this class as an argument to their 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 OutboundMessage and PluginMessageId properties to appropriate values.
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.
| Properties |
| OutboundMessage | Message to send back to Iguana, or an empty string if a message is not presently available. |
| PluginMessageId | Id to be assigned by the plugin to uniquely identify OutboundMessage. |
| StopChannelErrorFlag | When combined with StopChannelFlag, requests that Iguana stop the channel with the channel status set to 'error'. |
| StopChannelFlag | Requests that Iguana stop the channel to which the plugin is connected. |
| StopChannelReason | Describes the reason for the 'stop channel' request. |
| Methods |
| AddDebugLogMessage | Adds a debug log message to Iguana's logs. |
| AddErrorLogMessage | Adds an error log message to Iguana's logs. |
| AddInfoLogMessage | Adds an info log message to Iguana's logs. |
| AddWarningLogMessage | Adds a warning log message to Iguana's logs. |