SNode.C
Loading...
Searching...
No Matches
ConfigSection.hpp
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#include "net/config/ConfigSection.h" // IWYU pragma: export
43
44#ifndef DOXYGEN_SHOULD_SKIP_THIS
45
46#ifdef __GNUC__
47#pragma GCC diagnostic push
48#pragma GCC diagnostic ignored "-Wfloat-equal"
49#ifdef __has_warning
50#if __has_warning("-Wweak-vtables")
51#pragma GCC diagnostic ignored "-Wweak-vtables"
52#endif
53#if __has_warning("-Wcovered-switch-default")
54#pragma GCC diagnostic ignored "-Wcovered-switch-default"
55#endif
56#if __has_warning("-Wmissing-noreturn")
57#pragma GCC diagnostic ignored "-Wmissing-noreturn"
58#endif
59#if __has_warning("-Wnrvo")
60#pragma GCC diagnostic ignored "-Wnrvo"
61#endif
62#endif
63#endif
64#include "utils/CLI11.hpp" // IWYU pragma: export
65#ifdef __GNUC__
66#pragma GCC diagnostic pop
67#endif
68
69#endif // DOXYGEN_SHOULD_SKIP_THIS
70
71namespace net::config {
72
73 template <typename ValueType>
74 CLI::Option*
75 ConfigSection::addOption(const std::string& name, const std::string& description, const std::string& typeName, ValueType defaultValue) {
76 return addOption(name, description, typeName) //
77 ->default_val(defaultValue);
78 }
79
80 template <typename ValueType>
81 CLI::Option* ConfigSection::addOption(const std::string& name,
82 const std::string& description,
83 const std::string& typeName,
84 ValueType defaultValue,
85 const CLI::Validator& additionalValidator) {
86 return addOption(name, description, typeName, defaultValue) //
87 ->check(additionalValidator);
88 }
89
90 template <typename ValueType>
91 CLI::Option*
92 ConfigSection::addFlag(const std::string& name, const std::string& description, const std::string& typeName, ValueType defaultValue) {
93 return addFlag(name, description, typeName) //
94 ->default_val(defaultValue);
95 }
96
97 template <typename ValueType>
98 CLI::Option* ConfigSection::addFlag(const std::string& name,
99 const std::string& description,
100 const std::string& typeName,
101 ValueType defaultValue,
102 const CLI::Validator& additionalValidator) {
103 return addFlag(name, description, typeName, defaultValue) //
104 ->check(additionalValidator);
105 }
106
107} // namespace net::config
#define DECLARE_ROOTROUTE_REQUESTMETHOD(METHOD)
Definition RootRoute.h:68
#define DECLARE_ROUTE_REQUESTMETHOD(METHOD)
Definition Route.h:69
#define DEFINE_ROUTE_TEMPLATE_REQUESTMETHOD(METHOD, HTTP_METHOD)
Definition Route.hpp:61
#define DECLARE_ROUTER_REQUESTMETHOD(METHOD)
Definition Router.h:71
#define DEFINE_ROUTER_TEMPLATE_REQUESTMETHOD(METHOD, HTTP_METHOD)
Definition Router.hpp:53
unsigned long lastTick
Definition Controller.h:106
const std::shared_ptr< Request > & getRequest()
RootRoute * rootRoute
Definition Controller.h:98
bool setStrictRouting(bool strictRouting)
Controller(const std::shared_ptr< web::http::server::Request > &request, const std::shared_ptr< web::http::server::Response > &response)
bool getStrictRouting() const
bool setCaseInsensitiveRouting(bool caseInsensitiveRouting)
std::shared_ptr< Response > response
Definition Controller.h:96
Controller(const Controller &controller)
void setCurrentRoute(Route *currentRoute)
void setRootRoute(RootRoute *rootRoute)
bool getCaseInsensitiveRouting() const
std::shared_ptr< Request > request
Definition Controller.h:95
Controller & operator=(const Controller &controller) noexcept
const std::shared_ptr< Response > & getResponse()
Next(Controller &controller)
Definition Next.cpp:52
Controller controller
Definition Next.h:66
Request & extend()
Definition Request.cpp:75
std::string httpVersion
Definition Request.h:97
web::http::CiStringMap< std::string > cookies
Definition Request.h:104
Request(Request &&) noexcept=delete
std::string originalUrl
Definition Request.h:76
std::string url
Definition Request.h:96
Request & operator=(Request &&) noexcept=delete
std::vector< char > body
Definition Request.h:105
std::map< std::string, std::string > params
Definition Request.h:79
web::http::CiStringMap< std::string > queries
Definition Request.h:101
std::string method
Definition Request.h:95
Request(const std::shared_ptr< web::http::server::Request > &request) noexcept
Definition Request.cpp:57
std::shared_ptr< web::http::server::Request > requestBase
Definition Request.h:84
Request(Request &)=delete
web::http::CiStringMap< std::string > headers
Definition Request.h:102
web::http::CiStringMap< std::string > trailer
Definition Request.h:103
Request & operator=(Request &)=delete
std::string path
Definition Request.h:77
Request()=default
std::string file
Definition Request.h:78
std::string nullstr
Definition Request.h:108
bool isConnected() const
Definition Response.cpp:64
std::shared_ptr< web::http::server::Response > responseBase
Definition Response.h:97
Response & sendHeader()
Definition Response.cpp:185
Response(Response &&) noexcept=delete
Response & operator=(Response &&) noexcept=delete
Response & sendFragment(const char *chunk, std::size_t chunkLen)
Definition Response.cpp:191
Response(const std::shared_ptr< web::http::server::Response > &response) noexcept
Definition Response.cpp:57
Response & status(int status)
Definition Response.cpp:117
Response(Response &)=delete
void send(const char *chunk, std::size_t chunkLen)
Definition Response.cpp:165
Response & operator=(Response &)=delete
web::http::server::SocketContext * getSocketContext() const
Definition Response.cpp:68
bool setCaseInsensitiveRouting(bool caseInsensitiveRouting)
void dispatch(Controller &&controller)
void dispatch(Controller &controller)
bool setStrictRouting(bool strictRouting)
Definition RootRoute.cpp:95
std::list< std::string > getRoutes() const
Definition RootRoute.cpp:91
std::list< Route > & routes() const
Definition RootRoute.cpp:87
std::shared_ptr< dispatcher::RouterDispatcher > getDispatcher() const
Definition RootRoute.cpp:83
Route & patch(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:140
StrictRouting strictRouting
Definition Route.h:103
std::shared_ptr< Dispatcher > dispatcher
Definition Route.h:101
MountPoint mountPoint
Definition Route.h:100
Route & put(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:134
Route & head(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:141
Route & use(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:131
Route & connect(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:137
bool dispatch(Controller &controller)
Definition Route.cpp:80
Route & options(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:138
Route & setStrictRouting(bool strict=true)
Definition Route.cpp:121
Route & all(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:132
Route & del(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:136
Route & get(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:133
Route & post(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:135
const StrictRouting & getStrictRouting() const
Definition Route.cpp:127
Route & trace(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:139
const Router & setCaseInsensitiveRouting(bool caseInsensitiveRouting=true) const
Definition Router.cpp:84
const Router & setStrictRouting(bool strictRouting=true) const
Definition Router.cpp:78
Router(const Router &)=default
std::list< std::string > getRoutes() const
Definition Router.cpp:90
std::shared_ptr< RootRoute > rootRoute
Definition Router.h:121
std::map< std::string, web::http::CookieOptions > stdCookies
StaticMiddleware & setIndex(const std::string &index)
StaticMiddleware & appendStdHeaders(const std::string &field, const std::string &value)
web::http::ConnectionState defaultConnectionState
StaticMiddleware(const StaticMiddleware &)=delete
std::map< std::string, std::string > stdHeaders
StaticMiddleware & setStdHeaders(const std::map< std::string, std::string > &stdHeaders)
StaticMiddleware & operator=(const StaticMiddleware &)=delete
static class StaticMiddleware & instance(const std::string &root)
StaticMiddleware & appendStdCookie(const std::string &name, const std::string &value, const std::map< std::string, std::string > &options={})
StaticMiddleware & appendStdHeaders(const std::map< std::string, std::string > &stdHeaders)
StaticMiddleware(const std::string &root)
StaticMiddleware & afterResponse(web::http::ConnectionState connectionState)
VerboseRequest & operator=(const VerboseRequest &)=delete
VerboseRequest(const VerboseRequest &)=delete
CLI::Option * addFlag(const std::string &name, const std::string &description, const std::string &typeName, ValueType defaultValue)
CLI::Option * addFlag(const std::string &name, const std::string &description, const std::string &typeName, ValueType defaultValue, const CLI::Validator &additionalValidator)
CLI::Option * addOption(const std::string &name, const std::string &description, const std::string &typeName, ValueType defaultValue)
CLI::Option * addOption(const std::string &name, const std::string &description, const std::string &typeName, ValueType defaultValue, const CLI::Validator &additionalValidator)
void required(CLI::Option *opt, bool req=true)
constexpr AttributeProxy(const Attribute &attribute)
constexpr Attribute & operator*()
std::map< std::string, std::shared_ptr< void > > attributes
constexpr bool setAttribute(const Attribute &attribute, bool overwrite=false)
constexpr bool setAttribute(const Attribute &&attribute, bool overwrite=false)
std::shared_ptr< void > attribute
constexpr bool getAttribute(const std::function< void(Attribute &)> &onFound) const
int main(int argc, char *argv[])
#define QUOTE_INCLUDE(a)
Definition clients.h:47
#define STR_INCLUDE(a)
Definition servers.h:48
static express::Router getRouter()
Definition servers.h:68
static WebApp getWebApp(const std::string &name)
Definition servers.h:79
static WebApp getWebApp(const std::string &name)
Definition servers.h:96
Definition Config.h:59
fixed_string(char const (&)[N]) -> fixed_string< N - 1 >
std::string method
Definition MountPoint.h:56
std::string relativeMountPath
Definition MountPoint.h:57
auto operator<=>(const fixed_string &) const =default
constexpr fixed_string(char const *s)
constexpr operator char const *() const