com.interfaceware.iguana.plugin
Interface SourceListener

public interface SourceListener

The listener interface for receiving Source events. A class that is interested in processing a Source event must implement this interface (and all the methods it contains). The listener object created from that class is then registered with a Source object using the Source's addListener method. When the Source's state changes, the relevant method in the listener object is invoked. If you wish the Source object to stop receiving notifications, use the Source's removeListener method.

See Also:

Source

Method Summary

void	disconnected() Event raised upon disconnection of the plugin from Iguana.
void	messageRequestCompleted(SourceMessageRequestCompletedEventInputs Inputs, SourceMessageRequestCompletedEventOutputs Outputs) Event raised upon receipt of a message request completed notification from Iguana.
void	messageRequested(SourceMessageRequestedEventInputs Inputs, SourceMessageRequestedEventOutputs Outputs) Event raised upon receipt of a message request from Iguana.

Method Detail

messageRequested

void messageRequested(SourceMessageRequestedEventInputs Inputs,
                      SourceMessageRequestedEventOutputs Outputs)

Event raised upon receipt of a message request from Iguana.

The plugin should respond with either the next available unacknowledged message, or an empty message if no messages are available.

Exceptions should never be allowed to propagate out of the event handler. Event handlers should catch and handle all exceptions internally.

Parameters:

Inputs - Input data from Iguana.

Outputs - Output data to send back to Iguana.

messageRequestCompleted

void messageRequestCompleted(SourceMessageRequestCompletedEventInputs Inputs,
                             SourceMessageRequestCompletedEventOutputs Outputs)

Event raised upon receipt of a message request completed notification from Iguana.

Exceptions should never be allowed to propagate out of the event handler. Event handlers should catch and handle all exceptions internally.

Parameters:

Inputs - Input data from Iguana.

Outputs - Output data to send back to Iguana.

disconnected

void disconnected()

Event raised upon disconnection of the plugin from Iguana.

Will not be raised for failed connection attempts. Specifically, will not be raised if connect throws an exception as a result of a connection failure.

Exceptions should never be allowed to propagate out of the event handler. Event handlers should catch and handle all exceptions internally.