Table of Contents

IGQIUpdateable interface

Available from DataMiner 10.4.4/10.5.0 onwards.

Definition

  • Namespace: Skyline.DataMiner.Analytics.GenericInterface
  • Assembly: SLAnalyticsTypes.dll

The IGQIUpdateable interface can be implemented by an ad hoc data source class to provide real-time updates.

It defines a method pair, OnStartUpdates and OnStopUpdates, to respectively implement setup and teardown logic.

Methods

void OnStartUpdates(IGQIUpdater)

This method is invoked on an ad hoc data source when it is allowed to start publishing updates. It can for example be used to set up subscriptions or event handlers that trigger updates.

In the ad hoc data source life cycle, it is called after OnPrepareFetch and before any GetNextPage calls.

Note

This method will only be called if updates are enabled for the containing query and when that query can handle the updates. That way no resources are wasted.

Parameters

  • IGQIUpdater updater: An object on which an ad hoc data source can publish updates.

void OnStopUpdates()

This method is invoked on an ad hoc data source when it should stop publishing updates. It can for example be used to clean up any subscriptions or event handlers that were set up during the OnStartUpdates method.

In the ad hoc data source life cycle, it is called after the last GetNextPage call and right before OnDestroy.

Propose changes