An NDoc Documented Class Library

iNTERFACEWARE.IGC Namespace

Namespace hierarchy

Classes

Class	Description
Exception	This class represents exceptions to function calls.
MessageProcessor	This is the class that can be used to connect to Iguana in order to receive/dispatch messages. Simply ensure that a channel of Iguana is ready to receive a connection, and then connect using the hostname, port, channel name and component type ('source' or 'destination') (or ClientID).
MessageReceivedResponse	An instance of this class is provided as an argument to events. The values contained should be modified on event handling.
MessageRequestResponse	An instance of this class is provided as an argument to events. The values contained should be modified on event handling.

Delegates

Delegate	Description
MessageProcessor.IGCmessageProcessorOnDisconnect	This event is dispatched when the connection with Iguana is closed. The general reason for the disconnection is provided in the ReasonFlags, while additional details may be provided in the ReasonDescription. Note that exceptions can never be thrown out of this handler. Any exceptions thrown will result in the client executable aborting. It is recommended that logging or the handling of exceptions is performed in the handler.
MessageProcessor.IGCmessageProcessorOnMessageReceived	This event is dispatched when Iguana has received a message. Note that exceptions can never be thrown out of this handler. Any exceptions thrown will result in the client executable aborting. It is recommended that logging or the handling of exceptions is performed in the handler.
MessageProcessor.IGCmessageProcessorOnMessageRequest	This event is dispatched when Iguana is polling for a generated message. Note that exceptions can never be thrown out of this handler. Any exceptions thrown will result in the client executable aborting. It is recommended that logging or the handling of exceptions is performed in the handler.
MessageProcessor.IGCmessageProcessorOnMessageRequestCompleted	Once a message request is completed, this event is received. This indicates to the client that any transactions started by the request of the message can be committed. MessageSucceeded indicates if the message was logged as a success or error. The received Plugin Message ID indicates that the message was processed. If the message was processed in error by Iguana, this event is not received. As a result, when the next message request is received, the previous message generation operations should be rolled back. Note that exceptions can never be thrown out of this handler. Any exceptions thrown will result in the client executable aborting. It is recommended that logging or the handling of exceptions is performed in the handler.
MessageProcessor.IGCmessageProcessorOnMessageResubmitPreview	This event is dispatched when Iguana is attempting to resubmit a previously processed message. Not supported in Iguana 4.0.
MessageProcessor.IGCmessageProcessorOnShutdownRequest	Obsolete. This event has been superseded by the OnDisconnect event, and is retained only for backwards compatibility with existing plugins. New or updated plugins should use OnDisconnect instead. This event is dispatched when the connection with Iguana is closed for any reason other than the plugin calling disconnect (or destroying the message processor object). Typically, this event is received when the Iguana channel is stopping, however, it may also be received upon disconnection due to network failures or other error conditions. Note that exceptions can never be thrown out of this handler. Any exceptions thrown will result in the client executable aborting. It is recommended that logging or the handling of exceptions is performed in the handler.

Enumerations

Enumeration	Description
IGClogMessageType	Log message types passed to MessageReceivedResponse::addLogMessage and MessageRequestResponse::addLogMessage. These correspond to the log message types supported by the Iguana logging system itself.
MessageProcessor.IGCdisconnectReasonFlags	Disconnection reason flags provided to OnDisconnect.