1 #ifndef UMPS_MODULES_MODULE_HPP
2 #define UMPS_MODULES_MODULE_HPP
5 #include "umps/logging/level.hpp"
8 namespace Authentication
14 namespace ConnectionInformation
28 namespace UMPS::Modules
57 virtual void setName(
const std::string &name);
59 virtual std::string
getName() const noexcept;
72 virtual
void setZAPOptions(const UMPS::Authentication::ZAPOptions &options) noexcept;
74 [[nodiscard]] virtual UMPS::Authentication::ZAPOptions
getZAPOptions() const noexcept;
108 virtual
void setLogger(std::shared_ptr<UMPS::Logging::ILog> &logger);
111 [[nodiscard]] virtual std::shared_ptr<UMPS::Logging::ILog>
getLogger() const noexcept;
153 std::unique_ptr<IModuleImpl> pImpl;
Defines the logging level.
This is a generic base class module. It will implement some, but not all, generic module activities....
Definition: module.hpp:37
virtual void setHeartbeatBroadcastName(const std::string &name)
Sets the name of the heartbeat broadcast.
virtual void setLogger(std::shared_ptr< UMPS::Logging::ILog > &logger)
Sets the application's logger.
virtual void setName(const std::string &name)
Sets the module's name.
virtual bool haveOperatorAddress() const noexcept
virtual void setLogFileDirectory(const std::string &directory)
Sets the log file directory.
virtual std::string getLogFileDirectory() const noexcept
virtual void connect()
This will establish a connection to the.
virtual void start()
Starts the threads handling the heartbeating and commands.
virtual void stop()
Stops the threads handling the heartbeating and commands.
std::shared_ptr< UMPS::Services::ConnectionInformation::Requestor > getConnectionInformationRequestor() const
std::chrono::seconds getHeartbeatInterval() const noexcept
virtual std::string getHeartbeatBroadcastName() const noexcept
virtual void parseInitializationFile(const std::string &initializationFile)
Parses an initialization file and extracts the uOperator information from the uOperator section,...
virtual std::string getName() const noexcept
void disconnect()
Disconnects from the status and.
virtual void setZAPOptions(const UMPS::Authentication::ZAPOptions &options) noexcept
Sets the ZeroMQ authentication options.
virtual bool isConnected() const noexcept
virtual std::string getOperatorAddress() const
virtual UMPS::Authentication::ZAPOptions getZAPOptions() const noexcept
virtual void setOperatorAddress(const std::string &address)
Sets the operator address.
virtual UMPS::Logging::Level getVerbosity() const noexcept
virtual std::shared_ptr< UMPS::Logging::ILog > getLogger() const noexcept
virtual void setVerbosity(UMPS::Logging::Level verbosity) noexcept
Sets the module verbosity.
virtual void setHeartbeatInterval(const std::chrono::seconds &interval)
Sets the interval between status messages in the heartbeat broadcast.
bool keepRunning() const noexcept