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
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)
CLI::App * getApp() const
CallForCommandline(CLI::App *app, const std::string &description, Mode mode)
CLI::App * getApp() const
CallForShowConfig(CLI::App *app)
std::string getConfigFile() const
CallForWriteConfig(const std::string &configFile)
static void setVerboseLevel(int level)
Definition Logger.cpp:121
static void setLogLevel(int level)
Definition Logger.cpp:84
static void init()
Definition Logger.cpp:54
static void setQuiet(bool quiet=true)
Definition Logger.cpp:136
static CLI::Option * enforceLogFileOpt
Definition Config.h:147
static CLI::Option * verboseLevelOpt
Definition Config.h:149
static bool parse1()
Definition Config.cpp:398
static CLI::Option * addStringOption(const std::string &name, const std::string &description, const std::string &typeName, const std::string &defaultValue)
Definition Config.cpp:943
static CLI::Option * addStringOption(const std::string &name, const std::string &description, const std::string &typeName, const std::string &defaultValue, bool configurable)
Definition Config.cpp:958
static CLI::Option * groupNameOpt
Definition Config.h:146
static bool removeInstance(CLI::App *instance)
Definition Config.cpp:917
static std::string applicationName
Definition Config.h:137
static std::map< std::string, std::string > aliases
Definition Config.h:157
static CLI::App * addHelp(CLI::App *app)
Definition Config.cpp:835
static void addFlag(const std::string &name, bool &variable, const std::string &description, bool required, bool configurable=true, const std::string &groupName="Application Options")
Definition Config.cpp:988
static CLI::App * helpTriggerApp
Definition Config.h:153
static CLI::Option * addStringOption(const std::string &name, const std::string &description, const std::string &typeName, bool configurable)
Definition Config.cpp:937
static CLI::Option * addStringOption(const std::string &name, const std::string &description, const std::string &typeName, const char *defaultValue)
Definition Config.cpp:968
static std::shared_ptr< CLI::Formatter > sectionFormatter
Definition Config.h:129
static CLI::Option * logFileOpt
Definition Config.h:144
static std::string configDirectory
Definition Config.h:139
static std::shared_ptr< CLI::App > app
Definition Config.h:123
static std::string pidDirectory
Definition Config.h:141
static CLI::App * addSimpleHelp(CLI::App *app)
Definition Config.cpp:851
static CLI::App * getInstance(const std::string &name)
Definition Config.cpp:767
static void terminate()
Definition Config.cpp:698
static std::string getApplicationName()
Definition Config.cpp:1000
static CLI::App * showConfigTriggerApp
Definition Config.h:154
static void disabled(CLI::App *instance, bool disabled=true)
Definition Config.cpp:889
static CLI::App * addInstance(const std::string &name, const std::string &description, const std::string &group, bool final=false)
Definition Config.cpp:736
static int argc
Definition Config.h:132
static CLI::App * addStandardFlags(CLI::App *app)
Definition Config.cpp:771
static CLI::Option * userNameOpt
Definition Config.h:145
static std::map< std::string, CLI::Option * > applicationOptions
Definition Config.h:158
static CLI::Option * addStringOption(const std::string &name, const std::string &description, const std::string &typeName, const char *defaultValue, bool configurable)
Definition Config.cpp:975
static std::string logDirectory
Definition Config.h:140
static CLI::Option * addStringOption(const std::string &name, const std::string &description, const std::string &typeName)
Definition Config.cpp:923
static bool init(int argc, char *argv[])
Definition Config.cpp:136
static void required(CLI::App *instance, bool required=true)
Definition Config.cpp:866
static CLI::Option * quietOpt
Definition Config.h:150
static std::string getStringOptionValue(const std::string &name)
Definition Config.cpp:980
static CLI::Option * daemonizeOpt
Definition Config.h:143
static bool parse2()
Definition Config.cpp:583
static char ** argv
Definition Config.h:133
static bool bootstrap()
Definition Config.cpp:368
static int getLogLevel()
Definition Config.cpp:1004
static CLI::Option * logLevelOpt
Definition Config.h:148
static int getVerboseLevel()
Definition Config.cpp:1008
~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:211
pid_t getPid() const
Definition Daemon.cpp:214
DaemonSignaled(const std::string &message, pid_t pid)
Definition Daemon.cpp:206
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:158
~Daemon()=delete
static void erasePidFile(const std::string &pidFileName)
Definition Daemon.cpp:200
#define STR(a)
Definition clients.h:48
Definition Logger.h:66
Code
Definition Logger.h:68
@ FG_DEFAULT
Definition Logger.h:69
Definition Config.h:59
static std::string createCommandLineTemplate(CLI::App *app, CLI::CallForCommandline::Mode mode)
Definition Config.cpp:563
static void createCommandLineTemplate(std::stringstream &out, CLI::App *app, CLI::CallForCommandline::Mode mode)
Definition Config.cpp:548
static void createCommandLineOptions(std::stringstream &out, CLI::App *app, CLI::CallForCommandline::Mode mode)
Definition Config.cpp:453
static std::shared_ptr< CLI::App > makeApp()
Definition Config.cpp:101
static std::string bash_backslash_escape_no_whitespace(std::string_view s)
Definition Config.cpp:433
static std::string createCommandLineOptions(CLI::App *app, CLI::CallForCommandline::Mode mode)
Definition Config.cpp:518
static std::shared_ptr< CLI::HelpFormatter > makeSectionFormatter()
Definition Config.cpp:717
static std::string createCommandLineSubcommands(CLI::App *app, CLI::CallForCommandline::Mode mode)
Definition Config.cpp:533