Main class for the module, it create handlers and run them to, well, handle events and send command.
More...
#include <DoormanModule.hpp>
|
| virtual void | handle_pipe () |
| | The base class register the pipe_ socket to its reactor_ so that this function is called when the pipe_ is available from reading. More...
|
| |
| virtual void | handle_control () |
| | Handle called when a message on the module's control socket arrives. More...
|
| |
| virtual void | dump_additional_config (zmqpp::message *out) const |
| | Dump additional configuration (for example module specific config file). More...
|
| |
| void | dump_config (ConfigManager::ConfigFormat fmt, zmqpp::message *out_msg) const |
| | Fills a message with the module's configuration information. More...
|
| |
| void | config_check (const std::string &obj_name, Leosac::Hardware::DeviceClass type) |
| | An helper that checks configuration the existence of some objects. More...
|
| |
| void | config_check (const std::string &obj_name) |
| | An helper that checks configuration the existence of some objects. More...
|
| |
| zmqpp::context & | ctx_ |
| | A reference to the ZeroMQ context in case you need it to create additional socket. More...
|
| |
| zmqpp::socket & | pipe_ |
| | A reference to the pair socket that link back to the module manager. More...
|
| |
| boost::property_tree::ptree | config_ |
| | The configuration tree passed to the start_module function. More...
|
| |
| CoreUtilsPtr | utils_ |
| | Pointer to the core utils, which gives access to scheduler and others. More...
|
| |
| bool | is_running_ |
| | Boolean indicating whether the main loop should run or not. More...
|
| |
| zmqpp::socket | control_ |
| | Control REP socket. More...
|
| |
| zmqpp::reactor | reactor_ |
| | The reactor object we poll() on in the main loop. More...
|
| |
| std::string | name_ |
| |
Main class for the module, it create handlers and run them to, well, handle events and send command.
- See also
- Configuration Options for configuration information.
Definition at line 52 of file DoormanModule.hpp.
◆ DoormanModule() [1/2]
| DoormanModule::DoormanModule |
( |
zmqpp::context & |
ctx, |
|
|
zmqpp::socket * |
pipe, |
|
|
const boost::property_tree::ptree & |
cfg, |
|
|
CoreUtilsPtr |
utils |
|
) |
| |
◆ DoormanModule() [2/2]
| Leosac::Module::Doorman::DoormanModule::DoormanModule |
( |
const DoormanModule & |
| ) |
|
|
delete |
◆ ~DoormanModule()
| Leosac::Module::Doorman::DoormanModule::~DoormanModule |
( |
| ) |
|
|
default |
◆ doors()
| const std::vector< AuthTargetPtr > & DoormanModule::doors |
( |
| ) |
const |
◆ operator=()
◆ process_config()
| void DoormanModule::process_config |
( |
| ) |
|
|
private |
Processing the configuration tree, spawning AuthFileInstance object as described in the configuration file.
Definition at line 58 of file DoormanModule.cpp.
◆ process_doors_config()
| void DoormanModule::process_doors_config |
( |
const boost::property_tree::ptree & |
t | ) |
|
|
private |
◆ run()
| void DoormanModule::run |
( |
| ) |
|
|
overridevirtual |
This is the main loop of the module.
It should only exit when receiving signal::stop on its pipe_ socket. This is completely handled by this base class. In case you override this, make sure you watch the pipe_ socket.
Reimplemented from Leosac::Module::BaseModule.
Definition at line 111 of file DoormanModule.cpp.
◆ update()
| void DoormanModule::update |
( |
| ) |
|
|
private |
◆ doormen_
| std::vector<std::shared_ptr<DoormanInstance> > Leosac::Module::Doorman::DoormanModule::doormen_ |
|
private |
◆ doors_
Doors, to manage the always-on or always off stuff.
Definition at line 88 of file DoormanModule.hpp.
The documentation for this class was generated from the following files:
Inheritance diagram for Leosac::Module::Doorman::DoormanModule:
1.8.17