53 lines
1.4 KiB
C++
53 lines
1.4 KiB
C++
/**
|
|
* @file include/ActivMiddleware/ActivFramework/LicenseServiceApi.h
|
|
*
|
|
* @brief Header file for the license service api class.
|
|
*/
|
|
|
|
#if (!defined ACTIV_FRAMEWORK_LICENSE_SERVICE_API_H)
|
|
#define ACTIV_FRAMEWORK_LICENSE_SERVICE_API_H
|
|
|
|
#include "ActivMiddleware/ActivFramework/External.h"
|
|
|
|
//! Activ namespace.
|
|
namespace Activ
|
|
{
|
|
|
|
class Component;
|
|
class IniFileParser;
|
|
|
|
// ---------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
/**
|
|
* @brief Api to agent's license service.
|
|
*/
|
|
class LicenseServiceApi
|
|
{
|
|
public:
|
|
/**
|
|
* @brief Get the ini file parser containing the license.
|
|
*
|
|
* @param component component that wishes to get the ini file parser.
|
|
* @param iniFileParser reference to object to receive the ini file parser.
|
|
*
|
|
* @retval STATUS_CODE_SUCCESS
|
|
* @retval ...
|
|
*/
|
|
ACTIV_FRAMEWORK_API static StatusCode GetIniFileParser(const Component &component, IniFileParser &iniFileParser);
|
|
|
|
/**
|
|
* @brief Get name of the ini file section containing the license.
|
|
*
|
|
* @param component component that wishes to get the section name.
|
|
* @param sectionName reference to object to receive the section name.
|
|
*
|
|
* @retval STATUS_CODE_SUCCESS
|
|
* @retval ...
|
|
*/
|
|
ACTIV_FRAMEWORK_API static StatusCode GetSectionName(const Component &component, String §ionName);
|
|
};
|
|
|
|
} // namespace Activ
|
|
|
|
#endif // (!defined ACTIV_FRAMEWORK_LICENSE_SERVICE_API_H)
|