This class serves as a basis for custom UmModules More...
#include <UmModuleBase.hpp>
Inheritance diagram for Arp::System::Um::Commons::Modules::UmModuleBase:
Public Member Functions | |
| ARP_CXX_SYMBOL_EXPORT String | GetModuleName () const override |
| Return module name More... | |
 Public Member Functions inherited from Arp::System::Um::Commons::Modules::IUmModule | |
| IUmModule (void)=default | |
| Constructs an IUmModule instance. | |
| IUmModule (const IUmModule &arg)=default | |
| Copy constructor. | |
| IUmModule (IUmModule &&arg)=default | |
| Move constructor. | |
| IUmModule & | operator= (const IUmModule &arg)=default |
| Copy-assignment operator. | |
| IUmModule & | operator= (IUmModule &&arg)=default |
| Move-assignment operator. | |
| virtual | ~IUmModule (void)=default |
| Destructs this instance and frees all resources. | |
| virtual String | GetModuleName () const =0 |
| Return module name More... | |
| virtual bool | SetupModule (const String &settingsPath)=0 |
| Called by UmModuleManager, in order to setup the module. The IUmModule implementation should read its config file here, and register authentication providers. | |
| virtual bool | ResetModule ()=0 |
| Called by UmModuleManager, in order to reset/stop the module. | |
Additional Inherited Members | |
| Public Types inherited from Arp::System::Um::Commons::Modules::IUmModule | |
| using | Ptr = std::unique_ptr< IUmModule > |
Detailed Description
This class serves as a basis for custom UmModules
It provides methods for easier implementation
Member Function Documentation
◆ GetModuleName()
|
overridevirtual |
Return module name
Implements Arp::System::Um::Commons::Modules::IUmModule.
The documentation for this class was generated from the following files:
- Arp/System/Um/Commons/Modules/UmModuleBase.hpp
- Arp/System/Um/Commons/Modules/UmModuleBase.cpp
