SNode.C
Loading...
Searching...
No Matches
Config.h
Go to the documentation of this file.
1/*
2 * SNode.C - A Slim Toolkit for Network Communication
3 * Copyright (C) Volker Christian <me@vchrist.at>
4 * 2020, 2021, 2022, 2023, 2024, 2025, 2026
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser General Public License as published
8 * by the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20/*
21 * MIT License
22 *
23 * Permission is hereby granted, free of charge, to any person obtaining a copy
24 * of this software and associated documentation files (the "Software"), to deal
25 * in the Software without restriction, including without limitation the rights
26 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
27 * copies of the Software, and to permit persons to whom the Software is
28 * furnished to do so, subject to the following conditions:
29 *
30 * The above copyright notice and this permission notice shall be included in
31 * all copies or substantial portions of the Software.
32 *
33 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
34 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
35 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
36 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
37 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
38 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
39 * THE SOFTWARE.
40 */
41
42#ifndef UTILS_CONFIG_H
43#define UTILS_CONFIG_H
44
45#include "utils/SubCommand.h"
46
47#ifndef DOXYGEN_SHOULD_SKIP_THIS
48
49#include <cstddef>
50#include <string>
51
52#endif /* DOXYGEN_SHOULD_SKIP_THIS */
53
54namespace utils::config {} // namespace utils::config
55
56namespace utils {
57
58 class ConfigRoot : public utils::SubCommand {
59 private:
60 ConfigRoot();
61
62 public:
63 void* operator new(std::size_t) = delete;
64
65 ~ConfigRoot() override;
66
67 private:
68 ConfigRoot* addRootOptions(const std::string& applicationName,
69 const std::string& userName,
70 const std::string& groupName,
71 const std::string& configDirectory,
72 const std::string& logDirectory,
73 const std::string& pidDirectory);
74 bool parse1(int argc, char* argv[]);
75 bool bootstrap(int argc, char* argv[]);
76 bool parse2(int argc, char* argv[], bool parse1 = false);
77 void terminate();
78
79 std::string applicationName;
80 std::string pidDirectory;
81
82 CLI::Option* daemonizeOpt = nullptr;
83 CLI::Option* logFileOpt = nullptr;
84 CLI::Option* monochromLogOpt = nullptr;
85 CLI::Option* userNameOpt = nullptr;
86 CLI::Option* groupNameOpt = nullptr;
87 CLI::Option* enforceLogFileOpt = nullptr;
88 CLI::Option* logLevelOpt = nullptr;
89 CLI::Option* verboseLevelOpt = nullptr;
90 CLI::Option* quietOpt = nullptr;
91 CLI::Option* versionOpt = nullptr;
92 CLI::Option* writeConfigOpt = nullptr;
93 CLI::Option* killOpt = nullptr;
94 CLI::Option* aliasOpt = nullptr;
95
96 friend class Config;
97 };
98
99 class Config {
100 public:
101 Config() = delete;
102 Config(const Config&) = delete;
103 ~Config() = delete;
104
105 Config& operator=(const Config&) = delete;
106
107 static bool init(int argc, char* argv[]);
108 static bool bootstrap();
109 static void parse();
110 static void terminate();
111
112 static const std::string& getApplicationName();
113 static int getLogLevel();
114 static int getVerboseLevel();
115
117
118 private:
119 static int argc;
120 static char** argv;
121
122 static std::string applicationName;
123
124 static std::string configDirectory;
125 static std::string logDirectory;
126 static std::string pidDirectory;
127
128 friend class ConfigRoot;
129 };
130
131 //////////////////
132} // namespace utils
133
134#endif // UTILS_CONFIG_H
#define VLOG(level)
Definition Logger.h:164
ConfigDb(SubCommand *parent)
CLI::Option * hostOpt
static constexpr std::string_view NAME
static constexpr std::string_view DESCRIPTION
ConfigDb & setHost(const std::string &host)
std::string getHost()
void * operator new(std::size_t count)=delete
static void init(int argc, char *argv[])
Definition SNodeC.cpp:54
~SNodeC()=delete
static TickStatus tick(const utils::Timeval &timeOut=0)
Definition SNodeC.cpp:68
static void free()
Definition SNodeC.cpp:72
static void stop()
Definition SNodeC.cpp:64
SNodeC()=delete
static State state()
Definition SNodeC.cpp:76
static int start(const utils::Timeval &timeOut={LONG_MAX, 0})
Definition SNodeC.cpp:60
Timer(Timer &&timer) noexcept
Definition Timer.cpp:58
virtual ~Timer()
Definition Timer.cpp:78
Timer & operator=(Timer &&timer) noexcept
Definition Timer.cpp:67
Timer(core::TimerEventReceiver *timerEventReceiver)
Definition Timer.cpp:52
void restart()
Definition Timer.cpp:90
TimerEventReceiver * timerEventReceiver
Definition Timer.h:73
void cancel()
Definition Timer.cpp:84
void removeTimerEventReceiver()
Definition Timer.cpp:96
Timer()=default
Timer & operator=(const Timer &)=delete
Timer & operator=(Timer &&timer) noexcept=default
static Timer singleshotTimer(const std::function< void()> &dispatcher, const utils::Timeval &timeout)
Definition Timer.cpp:57
~Timer() override
Definition Timer.cpp:54
static Timer intervalTimer(const std::function< void(const std::function< void()> &)> &dispatcher, const utils::Timeval &timeout)
Definition Timer.cpp:61
Timer(Timer &&timer) noexcept=default
static Timer intervalTimer(const std::function< void()> &dispatcher, const utils::Timeval &timeout)
Definition Timer.cpp:65
MariaDBClientASyncAPI(const MariaDBClientASyncAPI &)=default
virtual MariaDBCommandSequence & execute_async(MariaDBCommand *mariaDBCommand)=0
virtual void execute_sync(MariaDBCommandSync *mariaDBCommand)=0
MariaDBClientSyncAPI(const MariaDBClientSyncAPI &)=default
MariaDBClient(const MariaDBConnectionDetails &details, const std::function< void(const MariaDBState &)> &onStateChanged)
void execute_sync(MariaDBCommandSync *mariaDBCommand) final
MariaDBCommandSequence & execute_async(MariaDBCommand *mariaDBCommand) final
std::function< void(const MariaDBState &)> onStateChanged
MariaDBConnection * mariaDBConnection
MariaDBConnectionDetails details
MariaDBCommandSequence & operator=(MariaDBCommandSequence &&mariaDBCommandSequence)=default
void execute_sync(MariaDBCommandSync *mariaDBCommand) final
std::deque< MariaDBCommand * > & sequence()
MariaDBCommandSequence & execute_async(MariaDBCommand *mariaDBCommand) final
std::deque< MariaDBCommand * > commandSequence
MariaDBCommandSequence(MariaDBCommandSequence &&mariaDBCommandSequence) noexcept=default
LogMessage(Level level, int verboseLevel=-1, bool withErrno=false)
Definition Logger.cpp:280
CLI::Option * enforceLogFileOpt
Definition Config.h:87
std::string pidDirectory
Definition Config.h:80
bool parse1(int argc, char *argv[])
Definition Config.cpp:463
CLI::Option * logFileOpt
Definition Config.h:83
CLI::Option * versionOpt
Definition Config.h:91
bool parse2(int argc, char *argv[], bool parse1=false)
Definition Config.cpp:546
CLI::Option * verboseLevelOpt
Definition Config.h:89
CLI::Option * killOpt
Definition Config.h:93
CLI::Option * aliasOpt
Definition Config.h:94
bool bootstrap(int argc, char *argv[])
Definition Config.cpp:497
std::string applicationName
Definition Config.h:79
CLI::Option * userNameOpt
Definition Config.h:85
void * operator new(std::size_t)=delete
CLI::Option * daemonizeOpt
Definition Config.h:82
CLI::Option * monochromLogOpt
Definition Config.h:84
ConfigRoot * addRootOptions(const std::string &applicationName, const std::string &userName, const std::string &groupName, const std::string &configDirectory, const std::string &logDirectory, const std::string &pidDirectory)
Definition Config.cpp:361
CLI::Option * writeConfigOpt
Definition Config.h:92
CLI::Option * groupNameOpt
Definition Config.h:86
CLI::Option * quietOpt
Definition Config.h:90
CLI::Option * logLevelOpt
Definition Config.h:88
~ConfigRoot() override
Definition Config.cpp:358
static std::string applicationName
Definition Config.h:122
Config(const Config &)=delete
static const std::string & getApplicationName()
Definition Config.cpp:785
static std::string configDirectory
Definition Config.h:124
static std::string pidDirectory
Definition Config.h:126
~Config()=delete
static void terminate()
Definition Config.cpp:781
static void parse()
Definition Config.cpp:777
static int argc
Definition Config.h:119
static std::string logDirectory
Definition Config.h:125
static bool init(int argc, char *argv[])
Definition Config.cpp:651
static ConfigRoot configRoot
Definition Config.h:116
Config & operator=(const Config &)=delete
Config()=delete
static char ** argv
Definition Config.h:120
static bool bootstrap()
Definition Config.cpp:773
static int getLogLevel()
Definition Config.cpp:789
static int getVerboseLevel()
Definition Config.cpp:793
CLI::Option * setConfigurable(CLI::Option *option, bool configurable) const
Timeval(const std::initializer_list< time_t > &initList) noexcept
Definition Timeval.cpp:59
int main(int argc, char *argv[])
Definition Timer.h:59
TickStatus
Definition TickStatus.h:51
State
Definition State.h:51
@ RUNNING
Definition State.h:51
@ INITIALIZED
Definition State.h:51
@ STOPPING
Definition State.h:51
State eventLoopState()
Definition State.cpp:52
Definition Config.h:54