TIGCsource Component Properties Methods Events |
This class is used to implement an Iguana source plugin.
Unit
IGC
Declaration
TIGCsource = class(TComponent)
Description
Source plugins connect to, and send messages to Iguana From-Plugin channel components.
Messages are sent to Iguana using a "polling" or "pull" approach (as opposed to a "push" approach). Iguana sends a message request to the TIGCsource plugin, raising the OnMessageRequested event. The TIGCsource plugin responds with the next available unacknowledged message. Once Iguana has received and enqueued the message, a message request completed notification is sent back to the TIGCsource plugin, raising the OnMessageRequestCompleted event. The TIGCsource plugin notes that the message has been acknowledged, and that it can advance to the next available message.
The message polling cycle repeats without delay while messages are available. Once all available messages have been transferred (indicated by the plugin responding to a message request with an empty message), the cycle repeats at an interval determined by the Polling Time configured in the channel's From-Plugin component.
See
http://www.interfaceware.com/manual/plugin_sending.html
for more information.
Properties |
ConnectTimeout | Time in milliseconds the plugin will wait to handshake with Iguana while executing the Connect operation (default 5000 milliseconds). |
DisconnectReason | Describes the reason for the plugin's (most recent) disconnection from Iguana. |
Methods |
Connect | Connects to an Iguana From-Plugin channel component as a source plugin. |
Disconnect | Disconnects the plugin from Iguana. |
EnableDebugLogging | Enables logging of internal runtime debug information to the specified file. |
WaitForDisconnect | Waits until the plugin is disconnected from Iguana. |
WaitForDisconnectWithTimeout | Waits until either the plugin is disconnected from Iguana, or a specified timeout elapses. |
Events |
OnDisconnected | Event raised upon disconnection of the plugin from Iguana. |
OnMessageRequestCompleted | Event raised upon receipt of a message request completed notification from Iguana. |
OnMessageRequested | Event raised upon receipt of a message request from Iguana. |