Use this service for the retain backup handling.
More...
#include <IRetainManagerService.hpp>
|
static IRscServiceProxyFactory & | GetProxyFactory (void) |
|
static IRscServiceProxyFactory & | GetProxyFactory (void) |
| Returns a reference to service proxy factory to create a proxy instance of the service More...
|
|
Use this service for the retain backup handling.
◆ IRetainManagerService()
IRetainManagerService::IRetainManagerService |
( |
void |
| ) |
|
|
inline |
◆ ~IRetainManagerService()
IRetainManagerService::~IRetainManagerService |
( |
void |
| ) |
|
|
inlinevirtual |
Destructs this instance and frees all resouces.
◆ GenerateBackupFile()
virtual BackupResult Arp::Plc::Retain::Services::IRetainManagerService::GenerateBackupFile |
( |
| ) |
|
|
pure virtual |
Generates a backup file of the retain data
Generates a backup file of all configured retain data including a header with several information e.g. version, project name, hw name, fw version, etc. The backup file is stored in the configured retain backup path. The name of the backup file is generated from the time of creation with the suffix '_USER'. E.g.: 2020_06_02_14_44_23_User
- Returns
- A result item which contains the created backup file name and an error code.
◆ PrepareLatestBackupFileForRestoring()
virtual BackupResult Arp::Plc::Retain::Services::IRetainManagerService::PrepareLatestBackupFileForRestoring |
( |
| ) |
|
|
pure virtual |
Prepares the latest backup file of retain data for restoring for the next plc 'RestoreWarm' start
Prepares the retain data of the lastest retain backup file based on the name, which is contained in the configured retain backup path and matched to the format defined. On the next 'RestoreWarm' start the prepared backup data is used instead of the data from the retain memory. The prepared backup will be cleared at each plc start (Cold, Warm, Hot, RestoreWarm), DCG and PlcReset.
- Returns
- An item which contains the prepared backup file name and an error code.
The documentation for this class was generated from the following file: