Files

114 lines
3.0 KiB
C++

/**
* @file include/ActivMiddleware/ActivAgentApplication/LoggerService.h
*
* @brief Header file for the logger service class.
*/
#if (!defined ACTIV_AGENT_APPLICATION_LOGGER_SERVICE_H)
#define ACTIV_AGENT_APPLICATION_LOGGER_SERVICE_H
#include "ActivMiddleware/ActivAgentApplication/External.h"
//! Activ namespace.
namespace Activ
{
/**
* @brief Logger service class.
*/
class LoggerService : private ManagedEndPoint, public Component
{
public:
using Component::GetApplication;
/**
* @brief Settings.
*/
class Settings
{
public:
/**
* @brief Default constructor.
*/
ACTIV_AGENT_APPLICATION_API Settings();
/**
* @brief Destructor.
*/
ACTIV_AGENT_APPLICATION_API ~Settings();
/**
* @brief Read settings from an ini file section.
*
* @param sectionIterator iterator to an ini file section.
*
* @throw Exception
*/
ACTIV_AGENT_APPLICATION_API void Read(const IniFileParser::ConstSectionIterator &sectionIterator);
IHeap::Settings m_heapSettings; ///< Heap properties for logger service, default buckets above.
ManagedEndPoint::Settings m_managedEndPointSettings;
String m_defaultLogDirectory; ///< Directory to put logs in if none specified, default current.
size_t m_systemLogHistorySize; ///< Number of system log entries to cache.
size_t m_numberOfInactiveDaysBeforeLogPurge; ///< Number of days before an inactive log is cleared.
std::vector<LogType> m_publishLogTypeList; ///< Publish log messages with any of these LogTypes.
};
/**
* @brief Logger service ui component.
*/
class UiComponent ACTIV_FINAL : public Activ::UiComponent
{
public:
/**
* @brief Constructor.
*
* @param loggerService the logger service to have the ui.
* @param uiServiceName name of the ui service.
*
* @throw Exception.
*/
ACTIV_AGENT_APPLICATION_API UiComponent(LoggerService &loggerService, const String &uiServiceName);
private:
virtual void Run(UiUser &uiUser) ACTIV_OVERRIDE;
LoggerService & m_loggerService;
// Last member.
Component::Enabler m_componentEnabler;
};
/**
* @brief Constructor.
*
* @param application the application the endpoint is running in.
* @param serviceName the name of the logger service.
* @param settings settings for the service.
*
* @throw Exception.
*/
ACTIV_AGENT_APPLICATION_API LoggerService(Application &application, const String &serviceName, const Settings &settings);
/**
* @brief Destructor.
*/
ACTIV_AGENT_APPLICATION_API ~LoggerService();
class Impl;
protected:
ACTIV_AGENT_APPLICATION_API virtual bool CanThreadExit() ACTIV_OVERRIDE;
ACTIV_AGENT_APPLICATION_API virtual StatusCode OnRequest(HeapMessage &request) ACTIV_OVERRIDE;
ACTIV_AGENT_APPLICATION_API virtual StatusCode OnMessage(HeapMessage &message) ACTIV_OVERRIDE;
ACTIV_AGENT_APPLICATION_API virtual StatusCode OnTimer(const Address &timerAddress, const DateTime &dateTime) ACTIV_OVERRIDE;
private:
Boost::scoped_ptr<Impl> m_pImpl;
};
} // namespace Activ
#endif // (!defined ACTIV_AGENT_APPLICATION_LOGGER_SERVICE_H)