ClientProperties Struct Reference

#include <ClientProperties.h>

Detailed Description

Client properties.

These are set at client creation and used internally in e.g. licensing requests.

Classes
class	Builder
	Builds the configuration fluently. More...

Public Member Functions
	ClientProperties ()
	No-arg constructs new instance without any properties.
	ClientProperties (const std::string &hardwareId, const std::string &hardwareName, const std::string &processId, const std::string &processName)
	Constructs new instance.
bool	hasHardwareId () const
	Checks if ClientProperties.hardwareId has been configured.
bool	hasHardwareName () const
	Checks if ClientProperties.hardwareName has been configured.
bool	hasProcessId () const
	Checks if ClientProperties.processId has been configured.
bool	hasProcessName () const
	Checks if ClientProperties.processName has been configured.

Public Attributes
const std::string	hardwareId
	The hardware ID of the client device.
const std::string	hardwareName
	A human-readable name of the hardware or device.
const std::string	processId
	The process ID of the client application requesting the license.
const std::string	processName
	The name of the client application requesting the license.

Constructor & Destructor Documentation

ClientProperties()

tenduke::ee::ClientProperties::ClientProperties ( const std::string & hardwareId, const std::string & hardwareName, const std::string & processId, const std::string & processName )

inline

Constructs new instance.

Parameters

hardwareId	-
hardwareName	-
processId	-
processName	-

Member Function Documentation

hasHardwareId()

bool tenduke::ee::ClientProperties::hasHardwareId ( ) const

inline

Checks if ClientProperties.hardwareId has been configured.

Returns

-

hasHardwareName()

bool tenduke::ee::ClientProperties::hasHardwareName ( ) const

inline

Checks if ClientProperties.hardwareName has been configured.

Returns

-

hasProcessId()

bool tenduke::ee::ClientProperties::hasProcessId ( ) const

inline

Checks if ClientProperties.processId has been configured.

Returns

-

hasProcessName()

bool tenduke::ee::ClientProperties::hasProcessName ( ) const

inline

Checks if ClientProperties.processName has been configured.

Returns

-

Member Data Documentation

hardwareId

const std::string tenduke::ee::ClientProperties::hardwareId

The hardware ID of the client device.

This is a mandatory parameter when consuming licenses where the license model limits the number of devices allowed. Note: We recommend that you provide the hardware ID when possible.

processId

const std::string tenduke::ee::ClientProperties::processId

The process ID of the client application requesting the license.

This information is needed if the license model defines a process as a lease anchor. See more information on session anchors in the ConcurrentSessions constraint in custom license models.

---

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

• client/enterprise/api/src/config/ClientProperties.h