AlarmAggregator

public interface AlarmAggregator

Method Summary

Modifier and Type

Method

Description

void

subscribe(QualifiedPath path, Consumer<AlarmStateSummary> subscriber)

All nested children alarms under the argument path will have their AlarmStateSummaries aggregated and subscribers will be notified of summary changes.

void

unsubscribe(QualifiedPath path, Consumer<AlarmStateSummary> subscriber)

Provides the ability to unsubscribe to a given qualified path and/or consumer

Method Details
- subscribe
  
  void subscribe(@Nullable QualifiedPath path, Consumer<AlarmStateSummary> subscriber)
  
  All nested children alarms under the argument path will have their AlarmStateSummaries aggregated and subscribers will be notified of summary changes.
  
  Parameters:
  
  path - The QualifiedPath whose AlarmStateSummary is being subscribed to
  
  subscriber - The subscriber to be notified when the AlarmStateSummary of the subscribed path is updated. Multiple subscribers may exist for a single QualifiedPath.
- unsubscribe
  
  void unsubscribe(@Nullable QualifiedPath path, Consumer<AlarmStateSummary> subscriber)
  
  Provides the ability to unsubscribe to a given qualified path and/or consumer
  
  Parameters:
  
  path - The QualifiedPath which should be unsubscribed from
  
  subscriber - The subscriber which is unsubscribing. Multiple subscribers may exist for a single QualifiedPath.