SNode.C
Loading...
Searching...
No Matches
Daemon.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_DAEMON_H
43#define UTILS_DAEMON_H
44
45#ifndef DOXYGEN_SHOULD_SKIP_THIS
46
47#include "core/system/unistd.h"
48
49#include <stdexcept>
50#include <string>
51
52#endif // DOXYGEN_SHOULD_SKIP_THIS
53
54namespace utils {
55 class DaemonFailure : public std::runtime_error {
56 public:
57 explicit DaemonFailure(const std::string& failureMessage);
58
59 ~DaemonFailure() override;
60 };
61
62 class DaemonError : public DaemonFailure {
63 public:
64 explicit DaemonError(const std::string& errorMessage);
65
66 ~DaemonError() override;
67 };
68
69 class DaemonSignaled : public std::runtime_error {
70 public:
71 explicit DaemonSignaled(const std::string& message, pid_t pid);
72
73 ~DaemonSignaled() override;
74
75 pid_t getPid() const;
76
77 private:
78 pid_t pid = 0;
79 };
80
81 class Daemon {
82 public:
83 Daemon() = delete;
84 ~Daemon() = delete;
85
86 static void startDaemon(const std::string& pidFileName, const std::string& userName, const std::string& groupName);
87 static pid_t stopDaemon(const std::string& pidFileName);
88
89 static void erasePidFile(const std::string& pidFileName);
90 };
91
92} // namespace utils
93
94#endif // UTILS_DAEMON_H
#define XSTR(s)
static void setDisableColor(bool disableColorLog=true)
Definition Logger.cpp:240
static void logToFile(const std::string &logFile)
Definition Logger.cpp:221
static void setVerboseLevel(int level)
Definition Logger.cpp:217
static void setLogLevel(int level)
Definition Logger.cpp:213
static void init()
Definition Logger.cpp:193
static void setQuiet(bool quiet=true)
Definition Logger.cpp:236
static bool getDisableColor()
Definition Logger.cpp:244
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:552
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:501
std::string applicationName
Definition Config.h:79
CLI::Option * userNameOpt
Definition Config.h:85
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
static const std::string & getApplicationName()
Definition Config.cpp:791
static std::string configDirectory
Definition Config.h:124
static std::string pidDirectory
Definition Config.h:126
static void terminate()
Definition Config.cpp:787
static void parse()
Definition Config.cpp:783
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:657
static ConfigRoot configRoot
Definition Config.h:116
static char ** argv
Definition Config.h:120
static bool bootstrap()
Definition Config.cpp:779
static int getLogLevel()
Definition Config.cpp:795
static int getVerboseLevel()
Definition Config.cpp:799
~DaemonError() override
Definition Daemon.cpp:72
DaemonError(const std::string &errorMessage)
Definition Daemon.cpp:68
~DaemonFailure() override
Definition Daemon.cpp:65
DaemonFailure(const std::string &failureMessage)
Definition Daemon.cpp:61
~DaemonSignaled() override
Definition Daemon.cpp:217
pid_t getPid() const
Definition Daemon.cpp:220
DaemonSignaled(const std::string &message, pid_t pid)
Definition Daemon.cpp:212
static void startDaemon(const std::string &pidFileName, const std::string &userName, const std::string &groupName)
Definition Daemon.cpp:75
Daemon()=delete
static pid_t stopDaemon(const std::string &pidFileName)
Definition Daemon.cpp:160
~Daemon()=delete
static void erasePidFile(const std::string &pidFileName)
Definition Daemon.cpp:202
std::string version() const
SubCommand * description(const std::string &description)
SubCommand * allowExtras(bool allow=true)
CLI::Option * addFlagFunction(const std::string &name, const std::function< void()> &callback, const std::string &description, const std::string &typeName, const std::string &defaultValue, const CLI::Validator &validator) const
SubCommand * footer(const std::string &footer)
void parse(int argc, char *argv[]) const
static CLI::App * showConfigTriggerApp
Definition SubCommand.h:245
CLI::Option * addFlag(const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &validator) const
Definition SubCommand.h:358
CLI::Option * addOption(const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &validator) const
Definition SubCommand.h:319
SubCommand(SubCommand *parent, std::shared_ptr< utils::AppWithPtr > appWithPtr, const std::string &group, bool final=false)
CLI::Option * setVersionFlag(const std::string &version) const
CLI::Option * helpOpt
Definition SubCommand.h:261
SubCommand * finalCallback(const std::function< void()> &finalCallback)
static CLI::App * helpTriggerApp
Definition SubCommand.h:244
CLI::Option * addOption(const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
CLI::Option * getOption(const std::string &name) const
CLI::Option * setConfig(const std::string &defaultConfigFile) const
static std::map< std::string, std::string > aliases
Definition SubCommand.h:242
std::string help(const CLI::App *helpApp, const CLI::AppFormatMode &mode) const
std::string configToStr() const
static CLI::App * commandlineTriggerApp
Definition SubCommand.h:246
CLI::Option * setLogFile(const std::string &defaultLogFile) const
CLI::Option * setConfigurable(CLI::Option *option, bool configurable) const
CLI::Option * addFlag(const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &validator) const
#define STR(a)
Definition clients.h:48
Definition Logger.h:55
Code
Definition Logger.h:57
@ FG_DEFAULT
Definition Logger.h:58
std::string operator+(const std::string &string, const Code &code)
Definition Logger.cpp:304
static std::string createCommandLineTemplate(CLI::App *app, utils::CallForCommandline::Mode mode)
Definition Config.cpp:226
static std::string createCommandLineOptions(CLI::App *app, utils::CallForCommandline::Mode mode)
Definition Config.cpp:181
static std::string doWriteConfig(utils::SubCommand *subCommand)
Definition Config.cpp:304
static std::string createCommandLineSubcommands(CLI::App *app, utils::CallForCommandline::Mode mode)
Definition Config.cpp:196
static std::string getHelp(utils::SubCommand *subCommand, CLI::App *helpTriggerApp)
Definition Config.cpp:329
static std::string getConfig(CLI::App *configTriggeredApp)
Definition Config.cpp:291
static void createCommandLineTemplate(std::stringstream &out, CLI::App *app, utils::CallForCommandline::Mode mode)
Definition Config.cpp:211
static void createCommandLineOptions(std::stringstream &out, CLI::App *app, utils::CallForCommandline::Mode mode)
Definition Config.cpp:101
static std::string bash_backslash_escape_no_whitespace(std::string_view s)
Definition Config.cpp:81
static std::string getCommandLine(CLI::App *commandlineTriggerApp)
Definition Config.cpp:246