SNode.C
Loading...
Searching...
No Matches
Router.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 EXPRESS_ROUTER_H
43#define EXPRESS_ROUTER_H
44
45#include "express/Next.h" // IWYU pragma: export
46#include "express/Request.h" // IWYU pragma: export
47#include "express/Response.h" // IWYU pragma: export
48#include "express/RootRoute.h" // IWYU pragma: export
49
50namespace express {
51 class Router;
52}
53
54#ifndef DOXYGEN_SHOULD_SKIP_THIS
55
56#include <functional> // IWYU pragma: export
57#include <list>
58#include <memory>
59#include <string>
60
61#endif /* DOXYGEN_SHOULD_SKIP_THIS */
62
63#define MIDDLEWARE(req, res, next)
64 ([[maybe_unused]] const std::shared_ptr<express::Request>& req,
65 [[maybe_unused]] const std::shared_ptr<express::Response>& res,
66 [[maybe_unused]] express::Next&(next))
67
68#define APPLICATION(req, res)
69 ([[maybe_unused]] const std::shared_ptr<express::Request>& req, [[maybe_unused]] const std::shared_ptr<express::Response>& res)
70
71#define DECLARE_ROUTER_REQUESTMETHOD(METHOD)
72 Route& METHOD(const Router& router) const;
73 Route& METHOD(const std::string& relativeMountPath, const Router& router) const;
74 Route& METHOD(const std::function<void(const std::shared_ptr<Request>&, const std::shared_ptr<Response>&)>& lambda) const;
75 Route& METHOD(const std::string& relativeMountPath,
76 const std::function<void(const std::shared_ptr<Request>&, const std::shared_ptr<Response>&)>& lambda) const;
77 Route& METHOD(const std::function<void(const std::shared_ptr<Request>&, const std::shared_ptr<Response>&, Next&)>& lambda) const;
78 Route& METHOD(const std::string& relativeMountPath,
79 const std::function<void(const std::shared_ptr<Request>&, const std::shared_ptr<Response>&, Next&)>& lambda) const;
80
81 template <typename... Lambdas>
82 Route& METHOD(const std::function<void(const std::shared_ptr<Request>&, const std::shared_ptr<Response>&)>& lambda,
83 Lambdas... lambdas) const;
84 template <typename... Lambdas>
85 Route& METHOD(const std::string& relativeMountPath,
86 const std::function<void(const std::shared_ptr<Request>&, const std::shared_ptr<Response>&)>& lambda,
87 Lambdas... lambdas) const;
88 template <typename... Lambdas>
89 Route& METHOD(const std::function<void(const std::shared_ptr<Request>&, const std::shared_ptr<Response>&, Next&)>& lambda,
90 Lambdas... lambdas) const;
91 template <typename... Lambdas>
92 Route& METHOD(const std::string& relativeMountPath,
93 const std::function<void(const std::shared_ptr<Request>&, const std::shared_ptr<Response>&, Next&)>& lambda,
94 Lambdas... lambdas) const;
95
96namespace express {
97
98 class Router {
99 public:
100 Router();
101 Router(const Router&) = default;
102
103 const Router& setStrictRouting(bool strictRouting = true) const;
104
105 std::list<std::string> getRoutes() const;
106
118
119 protected:
120 std::shared_ptr<RootRoute> rootRoute = nullptr;
121
122 friend class Route;
123 friend class RootRoute;
124 };
125
126} // namespace express
127
128#include "express/Router.hpp" // IWYU pragma: export
129
130#endif // EXPRESS_ROUTER_H
#define DECLARE_ROUTER_REQUESTMETHOD(METHOD)
Definition Router.h:71
#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
int main(int argc, char *argv[])