Class Hierarchy   Class Index   Method Index  

IGCdisconnectReason Class Reference

#include <IGCdisconnectReason.h>

Detailed Description

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

The IGCdisconnectReason for a plugin's most recent disconnection from Iguana may be retrieved from the IGCsource::DisconnectReason or IGCdestination::DisconnectReason properties, depending on the type of the plugin.

The disconnect reason includes three mutually exclusive flags indicating the reason for the disconnection: IGCdisconnectReason::DueToIguana, IGCdisconnectReason::DueToPlugin, and IGCdisconnectReason::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: IGCdisconnectReason::Description. The textual description may contain additional details useful in diagnosing unexpected disconnections, especially in the case of disconnection due to errors.


Public Member Functions

 IGCdisconnectReason ()
 Constructor.
virtual ~IGCdisconnectReason ()
 Destructor.
IGCdisconnectReason & operator= (const IGCdisconnectReason &Orig)
 Assignment operator.
IGCdisconnectReasonHandle GetHandle () const
 This method is part of the internal implementation of this class and should not be called.
IGCboolean DueToIguana () const
 Indicates that Iguana closed the connection with the plugin.
IGCboolean DueToPlugin () const
 Indicates that the plugin requested disconnection from Iguana.
IGCboolean DueToError () const
 Indicates that the connection between Iguana and the plugin was closed due to an error.
const char * Description () const
 Provides a textual description of the reason for disconnection.

Constructor & Destructor Documentation

IGCdisconnectReason::IGCdisconnectReason (   ) 
 

Constructor.

virtual IGCdisconnectReason::~IGCdisconnectReason (   )  [virtual]
 

Destructor.

Member Function Documentation

const char* IGCdisconnectReason::Description (   )  const
 

Provides a textual description of the reason for disconnection.

IGCboolean IGCdisconnectReason::DueToError (   )  const
 

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 IGCdisconnectReason::Description property.

IGCboolean IGCdisconnectReason::DueToIguana (   )  const
 

Indicates that Iguana closed the connection with the plugin.

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

IGCboolean IGCdisconnectReason::DueToPlugin (   )  const
 

Indicates that the plugin requested disconnection from Iguana.

Plugins may request disconnection by invoking the IGCsource::Disconnect or IGCdestination::Disconnect methods, depending on the type of plugin.

IGCdisconnectReasonHandle IGCdisconnectReason::GetHandle (   )  const [inline]
 

This method is part of the internal implementation of this class and should not be called.

IGCdisconnectReason& IGCdisconnectReason::operator= (  const IGCdisconnectReason &  Orig  ) 
 

Assignment operator.

The documentation for this class was generated from the following file: