10Duke Scale C++ Client
All Classes Namespaces Files Functions Variables Typedefs Enumerations Pages
tenduke::se::licensing::LicenseHeartbeatArguments Class Reference

#include <LicenseHeartbeatArguments.h>

Detailed Description

Describes single license lease to heartbeat.

Heartbeat request can contain 1-n of these.

Public Member Functions

 LicenseHeartbeatArguments (std::string leaseId, const bool treatAsIncrementalQty, const std::int64_t usedQty)
 Constructs new instance.
 

Public Attributes

const std::string leaseId
 Lease id value as it was returned in last heartbeat response or initial license checkout if no heartbeat has been done before this heartbeat request.
 
const bool treatAsIncrementalQty
 Flag that tells if the usedQty value is absolute or should be treated as an increment.
 
const std::int64_t usedQty
 The amount used since initial license checkout / previous heartbeat.
 

Constructor & Destructor Documentation

◆ LicenseHeartbeatArguments()

tenduke::se::licensing::LicenseHeartbeatArguments::LicenseHeartbeatArguments ( std::string leaseId,
const bool treatAsIncrementalQty,
const std::int64_t usedQty )
inline

Constructs new instance.

Parameters
leaseIdLease id value as it was returned in last heartbeat response or initial license checkout if no heartbeat has been done before this heartbeat request.
treatAsIncrementalQtyThe amount used since initial license checkout / previous heartbeat. The usage quantity is an absolute value by default. Set field treatAsIncrementalQty = true to use an incremental tracking algorithm instead. NOTE: does NOT APPLY when using SEAT based licensing.
usedQtyThe amount used since initial license checkout / previous heartbeat. The usage quantity is an absolute value by default. Set field treatAsIncrementalQty = true to use an incremental tracking algorithm instead. NOTE: does NOT APPLY when using SEAT based licensing.

Member Data Documentation

◆ treatAsIncrementalQty

const bool tenduke::se::licensing::LicenseHeartbeatArguments::treatAsIncrementalQty

Flag that tells if the usedQty value is absolute or should be treated as an increment.

NOTE: does NOT APPLY when using SEAT based licensing.

◆ usedQty

const std::int64_t tenduke::se::licensing::LicenseHeartbeatArguments::usedQty

The amount used since initial license checkout / previous heartbeat.

The usage quantity is an absolute value by default. Set field treatAsIncrementalQty = true to use an incremental tracking algorithm instead. NOTE: does NOT APPLY when using SEAT based licensing.


The documentation for this class was generated from the following file: