com::pcbsys::nirvana::nAdminAPI::nCommandStatus Class Referenceabstract

Any class implementing this interface can be used to find the current status of a request, for example a copy operation of a nLeafNode. More...

#include <nCommandStatus.h>

Inherits CountableObject.

Public Member Functions

virtual bool status (int percentComplete, longlong eid)=0
 Callback method used to indicate the current status of the command. More...
 

Detailed Description

Any class implementing this interface can be used to find the current status of a request, for example a copy operation of a nLeafNode.

Useful if the command takes a long time, the caller can implement this interface and get the current status and position.

If the implementing class returns false the command is aborted at that point.

Member Function Documentation

virtual bool com::pcbsys::nirvana::nAdminAPI::nCommandStatus::status ( int  percentComplete,
longlong  eid 
)
pure virtual

Callback method used to indicate the current status of the command.

Parameters
percentCompletePercent of the command completed
eidcurrent Event id the command is up to
Returns
boolean, if False causes the command to stop else continues.