Using a Destination Plugin |
A destination plugin is a plugin that receives messages from the To Plugin component of an Iguana channel.
Destination plugins use the Destination object, which is defined in the Iguana plugin libraries, to establish a connection to an Iguana channel. This object also generates the events that enable the destination plugin to communicate with the channel.
The Connect() method, which is defined in the Destination object, establishes the connection to the Iguana channel. This method requires three parameters:
The Connect() method requires three parameters:
- The hostname or IP address of your Iguana server (typically, this is localhost);
- The port that the Iguana plugin communication server is using (which is normally 6123);
- The name of the channel.
 | ||
|
You can configure your plugin to use a port other than 6123. For details, see Plugin Settings. | ||
 |
The following table lists the methods and properties defined for the Destination object:
| Method | Description |
|---|---|
| Connect() | Connects the plugin to the To Plugin component of an Iguana channel as a destination plugin. |
| ConnectTimeout() | The time, in milliseconds, that the plugin will wait for a connection with Iguana. |
| Disconnect() | Disconnects the plugin from Iguana. |
| DisconnectReason() | Describes the reason for the plugin's most recent disconnection from Iguana. |
| EnableDebugLogging() | Enables logging of internal runtime debug information. |
| WaitForDisconnect() | Waits until the plugin is disconnected from Iguana. |
| WaitForDisconnectWithTimeout() | Waits until the plugin is disconnected from Iguana or a specified timeout elapses. |
The events that the Destination object needs to respond to are:
| Event | Description |
|---|---|
| OnMessageReceived | The event generated when a message is received from Iguana. |
| OnResubmissionPreviewMessageReceived | The event generated when a resubmission preview message is received from Iguana. |
| OnDisconnected | This event is triggered when the connection between Iguana and the plugin is closed. |
The easiest way to write a plugin that receives messages is to use Chameleon to generate the plugin stubcode for you. For information on how to do this, refer to the page for the language in which you are writing the plugin:
- Using Chameleon to Generate a C++ Destination Plugin
- Using Chameleon to Generate a VB.NET Destination Plugin
- Using Chameleon to Generate a C# Destination Plugin
- Using Chameleon to Generate a Java Destination Plugin
- Using Chameleon to Generate a Delphi Destination Plugin