TIBCO FTL®
Public Member Functions | List of all members
TIBCO.FTL.INotificationHandler Interface Reference

In some situations, FTL must notify programs of conditions that preclude the use of event queues (as the communications medium). Instead of sending an advisory, FTL notifies the program through an out-of-band mechanism. More...

Public Member Functions

void OnNotification (RealmNotificationType type, string reason)
 Process out-of-band notifications. More...
 

Detailed Description

In some situations, FTL must notify programs of conditions that preclude the use of event queues (as the communications medium). Instead of sending an advisory, FTL notifies the program through an out-of-band mechanism.

Customer programs implement this interface to process notifications.

To implement this interface, define a notification handler class, with an INotificationHandler.OnNotification callback method to handle notifications (from the FTL library).

Programs create one instance of the notification handler class per realm, and may store closure data in fields of that instance. Programs call IRealm.SetNotificationHandler to register that instance.

Member Function Documentation

void TIBCO.FTL.INotificationHandler.OnNotification ( RealmNotificationType  type,
string  reason 
)

Process out-of-band notifications.

Programs define this callback method to process notifications. When the FTL library notifies the program out of band, it invokes this method in a thread that the library owns. Notications by-pass event queues.

Parameters
typeA notification code, which indicates the type of condition.
reasonA string describing the reason for the notification.