EdgeVisDecoderSDK::IServerEventListener Class Referenceabstract

Detailed Description

The interface for receiving CAMS notification events from the Server.

This is used to receive CAMS notifications matching the configured CAMS rules at the Server.

Threads

Care should be taken with threading within the EdgeVis SDK.

  • Callbacks from the SDK must not be blocked. Any processing resulting in a callback must be passed to a separate thread in your application and the callback complete as soon as possible
  • Callbacks from the SDK must not call back into the SDK on the same thread. Call back into the SDK on a separate thread.

Availability

Available in version 6.7.0 of Decoder SDK. Requires a server version greater than 6.5

#include <IServerEventListener.h>

Public Member Functions

virtual DB_EDGEVIS_SDK void CamsNotificationReceived (CamsNotification notification)=0
 Called when the Server has received a CAMS notification as a result of matching a CAMS rule. More...
 
virtual DB_EDGEVIS_SDK void CamsBulkNotificationReceived (CamsBulkNotification bulkNotification)=0
 Called when a state change has been applied to a range of CAMS notifications. More...
 
virtual DB_EDGEVIS_SDK void CamsRawSystemEventReceived (CamsNotificationEventDesc systemEvent)=0
 Called when a raw system event has been received. More...
 

Member Function Documentation

virtual DB_EDGEVIS_SDK void EdgeVisDecoderSDK::IServerEventListener::CamsNotificationReceived ( CamsNotification  notification)
pure virtual

Called when the Server has received a CAMS notification as a result of matching a CAMS rule.

This may be a completely new notification, or it could be an existing notification that has experienced a state change;

Parameters
notificationThe notification that has been received.
virtual DB_EDGEVIS_SDK void EdgeVisDecoderSDK::IServerEventListener::CamsBulkNotificationReceived ( CamsBulkNotification  bulkNotification)
pure virtual

Called when a state change has been applied to a range of CAMS notifications.

Parameters
bulkNotificationThe bulk notification that has been received. This contains the IDs and state change information for the notifications that have changed.
virtual DB_EDGEVIS_SDK void EdgeVisDecoderSDK::IServerEventListener::CamsRawSystemEventReceived ( CamsNotificationEventDesc  systemEvent)
pure virtual

Called when a raw system event has been received.

The system event may or may not be a source for a CAMS rule. All system events shall be available through this callback regardless of wheteher they have CAMS rules associated with them or the source of the event.

Parameters
systemEventAn object describing the system event that has been receieved.

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