![]() |
LicenseSpring C++ SDK 7.31.0
Easily add Software Licensing to your application
|
Class that saves license in a file, derived from LicenseFileStorageBase
class.
More...
#include <LicenseSpring/LicenseFileStorage.h>
Public Types | |
using | ptr_t = std::shared_ptr< FileStorageWithLock > |
![]() | |
using | ptr_t = std::shared_ptr< LicenseFileStorageBase > |
![]() | |
using | ptr_t = std::shared_ptr< LicenseStorage > |
Public Member Functions | |
FileStorageWithLock (const std::wstring &licensePath=std::wstring()) | |
FileStorageWithLock constructor. More... | |
void | saveLicense (const std::string &data) override |
Saves given license data string to the file. More... | |
std::string | loadLicense () override |
Load license from file. More... | |
void | clear () override |
Removes local license file. More... | |
uint32_t | attemptsCount () const |
Get file lock operation attempts count. More... | |
void | setAttemptsCount (uint32_t count) |
Set file lock operation attempts count. More... | |
uint32_t | waitTimeout () const |
Get timeout in milliseconds between file lock attempts. More... | |
void | setWaitTimeout (uint32_t timeout) |
Set timeout in milliseconds between file lock attempts. More... | |
![]() | |
LicenseFileStorageBase (const std::wstring &licensePath=std::wstring()) | |
Constructor for LicenseFileStorageBase object. More... | |
void | saveLicense (const std::string &data) override |
Saves given license data string to the file. More... | |
std::string | loadLicense () override |
Load license from file. More... | |
void | clear () override |
Removes local license file. More... | |
void | setLicenseFileName (const std::wstring &name) |
Setter for license filename with extension (optional). Default filename is License.key. More... | |
void | setLicenseFolderPath (const std::wstring &path) |
Setter for folder path where License file is being stored. More... | |
const std::wstring & | licenseFileName () const |
Getter for license filename with extension (optional). More... | |
const std::wstring & | licenseFolderPath () const |
Getter for folder path where License file is being stored. More... | |
std::wstring | licenseFilePath () const |
Getter for path to the license file. More... | |
![]() | |
virtual void | saveLicense (const std::string &licenseData)=0 |
Save license data somewhere. More... | |
virtual std::string | loadLicense ()=0 |
Load license data. More... | |
virtual void | clear ()=0 |
Removes local license data. More... | |
virtual | ~LicenseStorage () |
Destructor for LicenseStorage object. More... | |
Static Public Member Functions | |
static ptr_t | create (const std::wstring &licensePath=std::wstring()) |
Allocates and constructs a FileStorageWithLock object and passes args to FileStorageWithLock(). More... | |
![]() | |
static ptr_t | create (const std::wstring &licensePath=std::wstring()) |
Allocates and constructs a LicenseFileStorageBase object and passes args to LicenseFileStorageBase(). More... | |
Additional Inherited Members | |
![]() | |
std::wstring | prepareRead () const |
Prepare to read license file. More... | |
std::wstring | prepareWrite () const |
Prepare to write license file. More... | |
std::string | readLicense (const std::wstring &filePath) const |
Reads license from file. More... | |
void | writeLicense (const std::wstring &filePath, const std::string &data) const |
Writes given license data string to the file. More... | |
![]() | |
std::wstring | m_folderPath |
std::wstring | m_fileName |
Class that saves license in a file, derived from LicenseFileStorageBase
class.
Enhanced license file storage type for interprocess use. It uses file locking mechanism for synchronization. File operations of this class is thread and process safe.
Definition at line 194 of file LicenseFileStorage.h.
using LicenseSpring::FileStorageWithLock::ptr_t = std::shared_ptr<FileStorageWithLock> |
Definition at line 197 of file LicenseFileStorage.h.
LicenseSpring::FileStorageWithLock::FileStorageWithLock | ( | const std::wstring & | licensePath = std::wstring() | ) |
FileStorageWithLock constructor.
licensePath | The path that license folder path will be set to |
|
static |
Allocates and constructs a FileStorageWithLock object and passes args to FileStorageWithLock().
licensePath | The path that license folder path will be set to |
|
overridevirtual |
Saves given license data string to the file.
data | License data string |
Reimplemented from LicenseSpring::LicenseFileStorageBase.
|
overridevirtual |
Load license from file.
Reimplemented from LicenseSpring::LicenseFileStorageBase.
|
overridevirtual |
Removes local license file.
Reimplemented from LicenseSpring::LicenseFileStorageBase.
uint32_t LicenseSpring::FileStorageWithLock::attemptsCount | ( | ) | const |
Get file lock operation attempts count.
Default value is 20 attempts, min is 1.
void LicenseSpring::FileStorageWithLock::setAttemptsCount | ( | uint32_t | count | ) |
Set file lock operation attempts count.
count | Attempts count |
uint32_t LicenseSpring::FileStorageWithLock::waitTimeout | ( | ) | const |
Get timeout in milliseconds between file lock attempts.
Default value is 50ms, min is 10ms.
void LicenseSpring::FileStorageWithLock::setWaitTimeout | ( | uint32_t | timeout | ) |
Set timeout in milliseconds between file lock attempts.
timeout | Timeout in milliseconds |