|
IIGCdisconnectReason Interface Properties |
This class is used to describe the reason for a plugin's disconnection from Iguana.
Unit
IGC
Declaration
IIGCdisconnectReason = interface
Description
The IIGCdisconnectReason for a plugin's most recent disconnection from Iguana may be retrieved from the DisconnectReason or DisconnectReason properties, depending on the type of the plugin.
The disconnect reason includes three mutually exclusive flags indicating the reason for the disconnection: DueToIguana, DueToPlugin, and DueToError. These flags can be used programmatically to customize plugin disconnection handling depending on the cause of the disconnection.
The disconnect reason includes a textual description of the reason for disconnection: Description. The textual description may contain additional details useful in diagnosing unexpected disconnections, especially in the case of disconnection due to errors.
| Properties |
| Description | Provides a textual description of the reason for disconnection. |
| DueToError | Indicates that the connection between Iguana and the plugin was closed due to an error. |
| DueToIguana | Indicates that Iguana closed the connection with the plugin. |
| DueToPlugin | Indicates that the plugin requested disconnection from Iguana. |