BPNGClientLib
Library for accessing the Telemotive data logger devices
IBPNGClientListener.h
Go to the documentation of this file.
1 //******************************************************************************
2 //******************************************************************************
10 //******************************************************************************
11 //******************************************************************************
12 
13 #ifndef IBPNGCLIENTLISTENER_H
14 #define IBPNGCLIENTLISTENER_H
15 
16 #ifdef _WINDOWS
17 #include <windows.h>
18 #else
19 #include <iostream>
20 #endif
21 #include "BPNGDefines.h"
22 
23 extern "C"
24 {
26  {
28 
32  virtual void WINAPI onBPNGDeviceDetected(OnlineLoggerInfo* info) = 0;
33 
35 
39  virtual void WINAPI onBPNGDeviceDisappeared(OnlineLoggerInfo* info) = 0;
40 
42 
46  virtual void WINAPI onBPNGDeviceStateChange(OnlineLoggerInfo* info) = 0;
47 
49 
59  virtual int WINAPI onProgressDataDownload(int percentCompleted) = 0;
60 
62 
72  virtual int WINAPI onProgressDataDownload(int percentCompleted, uint64_t downloadedSize, uint64_t totalSize) = 0;
73 
75 
84  virtual int WINAPI onProgressConversion(int percentCompleted, const char* status) = 0;
85 
87 
95  virtual int WINAPI onProgressDeletion(int percentCompleted) = 0;
96 
98 
103  virtual void WINAPI onStatusMessage(const char* statusMsg) = 0;
104 
106 
110  virtual int WINAPI onDataRecoverProgress(const char* statusMsg, int percentage) = 0;
111 
113 
117  virtual void WINAPI onWarning(BPNGWarningCode warningCode, const char* warnMsg) = 0;
118 
120 
127  virtual int WINAPI onTargetPathTooLong(char* newTarget, int maxSize) = 0;
128 
130 
139  virtual int WINAPI getOverwritingPermission(const char* filePath) = 0;
140 
141 
143 
151  virtual const char* WINAPI onLogInDataRequired(unsigned mbnr) = 0;
152 
154 
158  virtual void WINAPI onInvalidPwConfigFound(unsigned mbnr) = 0;
159 
160  //
161  virtual void WINAPI onLogInDataFailed() = 0;
162  //
163  virtual void WINAPI onResetLogInDataFailed() = 0;
164 
165  //
166  virtual void WINAPI onFuncAccessDenied() = 0;
167 
169 
180  virtual int WINAPI onCriticalDiskSpace(uint64_t freeSpace, uint64_t neededSpace, const char* drive, const char* msg) = 0;
181 
183  virtual void WINAPI onFirmwareUpdateProgress(int percentage, int stepId, int subStepId, const char* desc) = 0;
184  virtual void WINAPI onFirmwareUpdateError(int errorId) = 0;
185 
188  virtual int WINAPI onGetLogReportProgress(int percentage, const char* desc) = 0;
189 
191 
195  virtual void WINAPI onDownloadStart(int64_t totalAmountOfBytes) = 0;
196 
198 
202  virtual void WINAPI onConversionStart(int64_t totalAmountOfBytes) = 0;
203 
206 
211  virtual const char* WINAPI onExtractionPasswordRequired(unsigned int retryCount) = 0;
212 
214  virtual bool WINAPI isTerminateLiveDownloadRequest() = 0;
215  };
216 
217 } // extern C
218 
219 #endif // IBPNGCLIENTLISTENER_H
BPNGWarningCode
Definition: BPNGDefines.h:262
virtual void WINAPI onDownloadStart(int64_t totalAmountOfBytes)=0
Notifies the listeners before the download starts about the total amount of bytes to be downloaded...
Struct with information about a logger found in LAN/WLAN used to notify IBPNGClientListener about det...
Definition: BPNGDefines.h:663
virtual void WINAPI onBPNGDeviceDetected(OnlineLoggerInfo *info)=0
Called to notify a detected logger in network.
virtual void WINAPI onWarning(BPNGWarningCode warningCode, const char *warnMsg)=0
Called to inform about a warning.
Definition: IBPNGClientListener.h:25
virtual void WINAPI onInvalidPwConfigFound(unsigned mbnr)=0
Called if invalid pw file found on device.
virtual int WINAPI getOverwritingPermission(const char *filePath)=0
Called on existing output trace files.
Defines for Telemotive Client Library.
virtual int WINAPI onTargetPathTooLong(char *newTarget, int maxSize)=0
Called on a too long target directory.
virtual int WINAPI onCriticalDiskSpace(uint64_t freeSpace, uint64_t neededSpace, const char *drive, const char *msg)=0
Called in case of not enough free diskspace.
virtual void WINAPI onFirmwareUpdateProgress(int percentage, int stepId, int subStepId, const char *desc)=0
Called on firmware update progress.
virtual void WINAPI onBPNGDeviceDisappeared(OnlineLoggerInfo *info)=0
Called to notify a disappeared logger.
virtual void WINAPI onConversionStart(int64_t totalAmountOfBytes)=0
Notifies the listeners before the conversion starts about the total amount of bytes to be converted...
virtual void WINAPI onBPNGDeviceStateChange(OnlineLoggerInfo *info)=0
Called to notify a logger&#39;s state change.
virtual const char *WINAPI onExtractionPasswordRequired(unsigned int retryCount)=0
virtual int WINAPI onDataRecoverProgress(const char *statusMsg, int percentage)=0
Called to send additional information of the current data recovery progress.
virtual const char *WINAPI onLogInDataRequired(unsigned mbnr)=0
Called on accessing password protected functions.
virtual void WINAPI onStatusMessage(const char *statusMsg)=0
Called to send additional information of the current process to the calling app.
virtual int WINAPI onProgressConversion(int percentCompleted, const char *status)=0
Called to indicate the current progress of file conversion.
virtual int WINAPI onGetLogReportProgress(int percentage, const char *desc)=0
virtual bool WINAPI isTerminateLiveDownloadRequest()=0
Called periodically on live download to query whether the permanent download should be finished...
virtual int WINAPI onProgressDeletion(int percentCompleted)=0
Called to indicate the current progress of file deletion.
virtual int WINAPI onProgressDataDownload(int percentCompleted)=0
Called to indicate the current progress of a data transfer.