License System

Interfaces and examples for interacting with the license system.

Collaboration diagram for License System:

Interfaces and examples for interacting with the license system.

Programmatically activating a License

Standalone applications using the framework require an active ImFusion license on the system they are running on. The simplest way to achieve this is by leveraging the framework's default behavior for license activation: If no active license is found on the system, the value of the environment variable IMFUSION_LICENSE_KEY is used to activate the license at application startup.

It is possible to change this default behavior by replacing it with your own logic. Do this by setting InitConfig::licenseInitFunction to your own implementation when calling Framework::init:

ImFusion::Framework::InitConfig initConfig;
initConfig.licenseInitFunction = []() {
    // Check if there is already an active license to avoid repeated activations.
    if (!LicenseManagerSDK::isActivated())
    {
        // Activate a license using the given key. You can hard-code a key here or prompt the user for one.
        LicenseManagerSDK::setLicenseKey("XXXX-XXXX-XXXX-XXXX");
    }
};
Framework::init(std::move(initConfig));

Gracefully handling license expiration during runtime

In the background the framework regularly checks if the active ImFusion license is still valid. If for some reason this check fails the framework will be forcefully deinitialized after some seconds of grace period. You can use this time to save the current state of your application and shut it down gracefully to avoid data loss for your users and inform them. In order to do this, register your own InitConfig::licenseExpirationHandler.

Note

The InitConfig::licenseExpirationHandler will be called from a separate thread.

Example code for a Qt application:

ImFusion::Framework::InitConfig initConfig;
initConfig.licenseExpirationHandler = [](const std::string& errMsg, int gracePeriodSec) {
    QMetaObject::invokeMethod(
        qApp,
        [errMsg, gracePeriodSec]() {
            std::stringstream ss;
            ss << "License issue! Quitting application gracefully before ImFusion::Framework will be de-initialized in " << gracePeriodSec << " seconds. Details: " << errMsg;
            LOG_ERROR(ss.str());
            qApp->quit();
        },
        Qt::QueuedConnection);    // put it in the event queue of the main thread because Qt windowing is not thread-safe
};
Framework::init(std::move(initConfig));