FireDAC.TFDEventAlerter Sample

From RAD Studio Code Examples
Jump to: navigation, search

This sample describes how to work with database events. TFDEventAlerter is used to receive event notifications.

Location

You can find the TFDEventAlerter sample project at:

Description

This sample uses the Use Connection Definition drop-down menu to select a connection definition. If the database supports events, then the application fills the supported event kinds.

You can register and unregister to an event. Click Fire events to start receiving the alerts when you are registered to the event.

How to Use the Sample

  1. Navigate to the location given above and open:
    • Delphi: EventAlerter.dproj
  2. Press F9 or choose Run > Run.
  3. Select a connection definition from the Use Connection Definition drop-down menu.
  4. Select the event kind or leave Default.
  5. Click Register events to register to the database events in order to receive notifications.
  6. Click Fire events to trigger the events.
  7. Click Unregister events to unregister to the database events to stop receiving notifications.
Note: The notifications are shown on the TMemo.

Implementation

  • Use Connection Definition drop-down menu:

The menu shows all the connections defined on the file at C:\Users\Public\Documents\Embarcadero\Studio\FireDAC\FDConnectionsDefs.ini.

If the database supports events, then the application fills the supported event kinds.

The Kind argument of the Options property of the TFDEventAlerter is set to the event alerter type or empty to use the default alerter.

Once the connection is defined, the Register events button is enabled to register and start accepting events.

  • Register events button:

To start receiving the event alert, the Register method is called. You can also set the Active property of the TFDEventAlerter to True.

Once you click Register events, the rest of buttons are enabled.

  • Fire events button:

Click Fire events to trigger the alerts.

When there is an alert, the OnAlert event handler is called and the event name and arguments are shown on the TMemo.

When there are no alerts for a "Timeout" period of time, the OnTimeout event handler is called and the Timeout message appears on the TMemo. The timeout period is set by specifying the Timeout argument of the Options property of the TFDEventAlerter.

The value is set to 1000 ms by default (1 sec).

  • Unregister events button:

To stop receiving the event alerts, the Unregister method is called by clicking Unregister events. You can also set the Active property of the TFDEventAlerter to False to unable alerts.

Uses

See Also

Personal tools
Assistance