AP&C API Reference
Public Member Functions | Properties | List of all members
Apac.Monitoring.AlertCache Class Reference

Provides a cached list of alerts organized by element Id and event Id for fast lookup. More...

Public Member Functions

 AlertCache ()
 Initializes a new instance of the AlertCache class. More...
 
Alert[] All ()
 Returns all cached alerts. More...
 
Alert[] FindAll (Predicate< Alert > match)
 Finds all alerts that match according to match . More...
 
void Clear ()
 Clears the cache. More...
 
void Reload (Alerts alerts)
 Reloads the cache with the specified alerts. More...
 
Alert Check (uint elementId, uint eventId)
 Checks the cache. More...
 
void Update (Alert alert)
 Updates the cache, if a matching alert does not exist in the cache. More...
 
void Remove (Alert alert)
 Removes from cache. More...
 

Properties

int Count [get]
 Returns the number of alerts in the cache More...
 

Detailed Description

Provides a cached list of alerts organized by element Id and event Id for fast lookup.

Constructor & Destructor Documentation

◆ AlertCache()

Apac.Monitoring.AlertCache.AlertCache ( )
inline

Initializes a new instance of the AlertCache class.

Member Function Documentation

◆ All()

Alert [] Apac.Monitoring.AlertCache.All ( )
inline

Returns all cached alerts.

Returns
Returns all cached alerts.

◆ Check()

Alert Apac.Monitoring.AlertCache.Check ( uint  elementId,
uint  eventId 
)
inline

Checks the cache.

Parameters
elementIdThe element id.
eventIdThe event id.
Returns
Returns a Alert from the cache, or null on a cache miss.

◆ Clear()

void Apac.Monitoring.AlertCache.Clear ( )
inline

Clears the cache.

◆ FindAll()

Alert [] Apac.Monitoring.AlertCache.FindAll ( Predicate< Alert match)
inline

Finds all alerts that match according to match .

Parameters
matchThe match.
Returns
Returns a T:Alert[] containing all matching alerts.

◆ Reload()

void Apac.Monitoring.AlertCache.Reload ( Alerts  alerts)
inline

Reloads the cache with the specified alerts.

Parameters
alertsThe alerts.

◆ Remove()

void Apac.Monitoring.AlertCache.Remove ( Alert  alert)
inline

Removes from cache.

Parameters
alertThe alert.

◆ Update()

void Apac.Monitoring.AlertCache.Update ( Alert  alert)
inline

Updates the cache, if a matching alert does not exist in the cache.

Parameters
alertThe alert.

Property Documentation

◆ Count

int Apac.Monitoring.AlertCache.Count
get

Returns the number of alerts in the cache


The documentation for this class was generated from the following file: