com.interfaceware.iguana.plugin
Class DisconnectReason

java.lang.Object
  com.interfaceware.iguana.plugin.DisconnectReason

public class DisconnectReason
extends java.lang.Object

This class is used to describe the reason for a plugin's disconnection from Iguana.

The DisconnectReason 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.

Constructor Summary

DisconnectReason()

DisconnectReason(long Handle)

Method Summary

protected void	finalize()
java.lang.String	getDescription() Provides a textual description of the reason for disconnection.
boolean	getDueToError() Indicates that the connection between Iguana and the plugin was closed due to an error.
boolean	getDueToIguana() Indicates that Iguana closed the connection with the plugin.
boolean	getDueToPlugin() Indicates that the plugin requested disconnection from Iguana.
void	release()

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DisconnectReason

public DisconnectReason()
                 throws PluginException

Throws:

PluginException

DisconnectReason

public DisconnectReason(long Handle)
                 throws PluginException

Throws:

PluginException

Method Detail

release

public void release()
             throws PluginException

Throws:

PluginException

finalize

protected void finalize()
                 throws PluginException

Overrides:

finalize in class java.lang.Object

Throws:

PluginException

getDueToIguana

public boolean getDueToIguana()
                       throws PluginException

Indicates that Iguana closed the connection with the plugin.

Iguana closes its connection with a plugin when stopping the plugin channel.

Throws:

PluginException

getDueToPlugin

public boolean getDueToPlugin()
                       throws PluginException

Indicates that the plugin requested disconnection from Iguana.

Plugins may request disconnection by invoking the disconnect or disconnect methods, depending on the type of plugin.

Throws:

PluginException

getDueToError

public boolean getDueToError()
                      throws PluginException

Indicates that the connection between Iguana and the plugin was closed due to an error.

A textual description of the error is available via the Description property.

Throws:

PluginException

getDescription

public java.lang.String getDescription()
                                throws PluginException

Provides a textual description of the reason for disconnection.

Throws:

PluginException