dca::ScheduleEventSubscriberIntf Class Reference
[DCA Base Package]

#include <base_classes.h>

Inheritance diagram for dca::ScheduleEventSubscriberIntf:
MyIprScheduleEventSubscriber MyScheduleEventSubscriber MyUrlScheduleEventSubscriber MyWacScheduleEventSubscriber

List of all members.


Detailed Description

An interface for schedule event notifications. Derive a class from this interface and implement onEvent() to receive notifications.

See also:
DcaInstance::schedule()

Definition at line 525 of file base_classes.h.

Public Member Functions

virtual void onEvent (ScheduleActionType actionType, ScheduleModuleId moduleId, const std::string &version, const std::string &text)=0
 Called by the schedule framework when a schedule event occurs.

Member Function Documentation

virtual void dca::ScheduleEventSubscriberIntf::onEvent ( ScheduleActionType  actionType,
ScheduleModuleId  moduleId,
const std::string &  version,
const std::string &  text 
) [pure virtual]

Called by the schedule framework when a schedule event occurs.

Parameters:
[in] actionType The event type
[in] moduleId The associated module
[in] version If available, the new version number of the module, otherwise the empty string
[in] text Notification text. In case of SAT_ProgressDbDownload, the text contains the download progress as a percentage, eg "67.25"

Implemented in MyIprScheduleEventSubscriber, MyUrlScheduleEventSubscriber, MyScheduleEventSubscriber, and MyWacScheduleEventSubscriber.


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

Generated on 26 Sep 2016 for dca_interface by  doxygen 1.6.1