SNode.C
Loading...
Searching...
No Matches
Route.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, 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 EXPRESS_ROUTE_HPP
43#define EXPRESS_ROUTE_HPP
44
45namespace express {
46
47 class Next;
48 class Request;
49 class Response;
50 class Route;
51
52} // namespace express
53
54#ifndef DOXYGEN_SHOULD_SKIP_THIS
55
56#include <functional> // for function
57#include <memory>
58
59#endif /* DOXYGEN_SHOULD_SKIP_THIS */
60
61#define DEFINE_ROUTE_TEMPLATE_REQUESTMETHOD(METHOD, HTTP_METHOD)
62 template <typename... Lambdas>
63 Route& Route::METHOD(const std::function<void(const std::shared_ptr<Request>&, const std::shared_ptr<Response>&)>& lambda,
64 Lambdas... lambdas) const {
65 return this->METHOD(lambda).METHOD(lambdas...);
66 }
67 template <typename... Lambdas>
68 Route& Route::METHOD(const std::function<void(const std::shared_ptr<Request>&, const std::shared_ptr<Response>&, Next&)>& lambda,
69 Lambdas... lambdas) const {
70 return this->METHOD(lambda).METHOD(lambdas...);
71 }
72
73namespace express {
74
86
87} // namespace express
88
89#endif // EXPRESS_ROUTE_HPP
#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 APPLICATION(req, res)
Definition Router.h:68
#define MIDDLEWARE(req, res, next)
Definition Router.h:63
static void init(int argc, char *argv[])
Definition SNodeC.cpp:54
static int start(const utils::Timeval &timeOut={LONG_MAX, 0})
Definition SNodeC.cpp:60
static constexpr int DISABLED
Definition State.h:56
static constexpr int ERROR
Definition State.h:57
std::string what() const
Definition State.cpp:114
static constexpr int FATAL
Definition State.h:58
static constexpr int OK
Definition State.h:55
unsigned long lastTick
Definition Controller.h:97
void next(const std::string &how) const
const std::shared_ptr< Request > & getRequest()
RootRoute * rootRoute
Definition Controller.h:92
bool dispatchNext(bool strictRouting, bool caseInsensitiveRouting, bool mergeParams)
Controller(const std::shared_ptr< web::http::server::Request > &request, const std::shared_ptr< web::http::server::Response > &response)
std::shared_ptr< Response > response
Definition Controller.h:90
Controller(const Controller &controller)
void setCurrentRoute(Route *currentRoute)
void setRootRoute(RootRoute *rootRoute)
std::shared_ptr< Request > request
Definition Controller.h:89
Controller & operator=(const Controller &controller) noexcept
const std::shared_ptr< Response > & getResponse()
void operator()(const std::string &how="") const
Definition Next.cpp:56
Next(Controller &controller)
Definition Next.cpp:52
Controller controller
Definition Next.h:66
Request & extend()
Definition Request.cpp:76
std::string httpVersion
Definition Request.h:99
web::http::CiStringMap< std::string > cookies
Definition Request.h:106
Request(Request &&) noexcept=delete
std::string originalUrl
Definition Request.h:77
const std::string & cookie(const std::string &key) const
Definition Request.cpp:99
std::string url
Definition Request.h:98
Request & operator=(Request &&) noexcept=delete
std::vector< char > body
Definition Request.h:107
std::map< std::string, std::string > params
Definition Request.h:81
const std::string & get(const std::string &key, int i=0) const
Definition Request.cpp:95
std::string originalPath
Definition Request.h:78
std::string method
Definition Request.h:97
Request(const std::shared_ptr< web::http::server::Request > &request) noexcept
Definition Request.cpp:56
std::shared_ptr< web::http::server::Request > requestBase
Definition Request.h:86
Request(Request &)=delete
const std::string & query(const std::string &key) const
Definition Request.cpp:109
web::http::CiStringMap< std::string > headers
Definition Request.h:104
const std::string & param(const std::string &id, const std::string &fallBack="")
Definition Request.cpp:70
std::string baseUrl
Definition Request.h:76
std::map< std::string, std::string > queries
Definition Request.h:103
web::http::CiStringMap< std::string > trailer
Definition Request.h:105
Request & operator=(Request &)=delete
std::string path
Definition Request.h:79
Request()=default
std::string file
Definition Request.h:80
std::string nullstr
Definition Request.h:110
bool isConnected() const
Definition Response.cpp:64
void download(const std::string &file, const std::string &fileName, const std::function< void(int)> &onError)
Definition Response.cpp:81
void redirect(const std::string &loc, const std::string &html={})
Definition Response.cpp:86
std::shared_ptr< web::http::server::Response > responseBase
Definition Response.h:97
Response & sendHeader()
Definition Response.cpp:185
Response & attachment(const std::string &fileName="")
Definition Response.cpp:99
Response & cookie(const std::string &name, const std::string &value, const std::map< std::string, std::string > &options={})
Definition Response.cpp:147
void redirect(int state, const std::string &loc, const std::string &html={})
Definition Response.cpp:90
Response & clearCookie(const std::string &name, const std::map< std::string, std::string > &options={})
Definition Response.cpp:153
Response(Response &&) noexcept=delete
Response & operator=(Response &&) noexcept=delete
void sendFile(const std::string &file, const std::function< void(int)> &callback)
Definition Response.cpp:181
void sendStatus(int state, const std::string &html={})
Definition Response.cpp:95
void download(const std::string &file, const std::function< void(int)> &onError)
Definition Response.cpp:77
Response & set(const std::string &field, const std::string &value, bool overwrite=true)
Definition Response.cpp:129
Response & setTrailer(const std::string &field, const std::string &value, bool overwrite=true)
Definition Response.cpp:159
Response & sendFragment(const char *chunk, std::size_t chunkLen)
Definition Response.cpp:191
Response & append(const std::string &field, const std::string &value)
Definition Response.cpp:123
Response & sendFragment(const std::string &chunk="")
Definition Response.cpp:197
void send(const std::string &chunk)
Definition Response.cpp:169
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 & vary(const std::string &field)
Definition Response.cpp:111
Response & operator=(Response &)=delete
Response & type(const std::string &type)
Definition Response.cpp:141
Response & set(const std::map< std::string, std::string > &headers, bool overwrite=true)
Definition Response.cpp:135
web::http::server::SocketContext * getSocketContext() const
Definition Response.cpp:68
const std::string & header(const std::string &field)
Definition Response.cpp:203
void json(const nlohmann::json &json)
Definition Response.cpp:72
void upgrade(const std::shared_ptr< Request > &request, const std::function< void(const std::string)> &status)
Definition Response.cpp:173
Response & location(const std::string &loc)
Definition Response.cpp:105
RootRoute & setMergeParams(bool mergeParams)
void dispatch(Controller &&controller)
Definition RootRoute.cpp:95
void dispatch(Controller &controller)
Route & head(const RootRoute &rootRoute) const
Route & del(const RootRoute &rootRoute) const
bool getStrictRouting() const
Route & connect(const RootRoute &rootRoute) const
std::list< std::string > getRoutes() const
Definition RootRoute.cpp:91
std::list< Route > & routes() const
Definition RootRoute.cpp:87
Route & get(const RootRoute &rootRoute) const
Route & trace(const RootRoute &rootRoute) const
Route & use(const RootRoute &rootRoute) const
Route & post(const RootRoute &rootRoute) const
Route & put(const RootRoute &rootRoute) const
bool getMergeParams() const
bool getCaseInsensitiveRouting() const
RootRoute & setCaseInsensitiveRouting(bool caseInsensitiveRouting)
Route & options(const RootRoute &rootRoute) const
Route & all(const RootRoute &rootRoute) const
std::shared_ptr< dispatcher::RouterDispatcher > getDispatcher() const
Definition RootRoute.cpp:83
Route & patch(const RootRoute &rootRoute) const
RootRoute & setStrictRouting(bool strictRouting)
Route & patch(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:111
std::shared_ptr< Dispatcher > dispatcher
Definition Route.h:94
MountPoint mountPoint
Definition Route.h:93
Route & put(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:105
Route & head(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:112
bool dispatchNext(Controller &controller, bool strictRouting, bool caseInsensitiveRouting, bool mergeParams)
Definition Route.cpp:94
Route & use(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:102
Route & connect(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:108
Route(const std::string &method, const std::string &relativeMountPath, const std::shared_ptr< Dispatcher > &dispatcher)
Definition Route.cpp:77
Route & options(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:109
Route & all(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:103
Route & del(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:107
Route & get(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:104
Route & post(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:106
std::list< std::string > getRoute(const std::string &parentMountPath, bool strictRouting) const
Definition Route.cpp:98
bool dispatch(Controller &controller, bool strictRouting, bool caseInsensitiveRouting, bool mergeParams)
Definition Route.cpp:82
Route & trace(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:110
Route & head(const Router &router) const
Definition Router.cpp:110
Route & all(const Router &router) const
Definition Router.cpp:101
const Router & setCaseInsensitiveRouting(bool caseInsensitiveRouting=true) const
Definition Router.cpp:84
const Router & setStrictRouting(bool strictRouting=true) const
Definition Router.cpp:78
Route & options(const Router &router) const
Definition Router.cpp:107
Route & connect(const Router &router) const
Definition Router.cpp:106
Route & post(const Router &router) const
Definition Router.cpp:104
Route & del(const Router &router) const
Definition Router.cpp:105
Router(const Router &)=default
Route & use(const Router &router) const
Definition Router.cpp:100
Route & get(const Router &router) const
Definition Router.cpp:102
Route & trace(const Router &router) const
Definition Router.cpp:108
Route & patch(const Router &router) const
Definition Router.cpp:109
const Router & setMergeParams(bool mergeParams=true) const
Definition Router.cpp:90
std::list< std::string > getRoutes() const
Definition Router.cpp:96
Route & put(const Router &router) const
Definition Router.cpp:103
std::shared_ptr< RootRoute > rootRoute
Definition Router.h:122
WebAppT(const std::string &name, const Router &router)
Definition WebAppT.h:80
typename Server::SocketConnection SocketConnection
Definition WebAppT.h:69
ServerT Server
Definition WebAppT.h:63
express::Response Response
Definition WebAppT.h:67
express::Request Request
Definition WebAppT.h:66
typename Server::SocketAddress SocketAddress
Definition WebAppT.h:70
WebAppT(const std::string &name)
Definition WebAppT.h:76
static void free()
Definition WebApp.cpp:72
static void init(int argc, char *argv[])
Definition WebApp.cpp:56
static void stop()
Definition WebApp.cpp:64
static core::TickStatus tick(const utils::Timeval &timeOut=0)
Definition WebApp.cpp:68
static core::State state()
Definition WebApp.cpp:76
static int start(const utils::Timeval &timeOut={LONG_MAX, 0})
Definition WebApp.cpp:60
WebApp(const Router &router)
Definition WebApp.cpp:52
std::string toString(bool expanded=true) const override
const Super & listen(uint16_t port, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
constexpr AttributeProxy(const Attribute &attribute)
constexpr Attribute & operator*()
constexpr bool setAttribute(const Attribute &&attribute, const std::string &subKey="", bool overwrite=false)
constexpr bool hasAttribute(const std::string &subKey="") const
constexpr bool delAttribute(const std::string &subKey="")
bool getAttribute(const std::function< void(Attribute &)> &onFound, const std::string &subKey="") const
std::map< std::string, std::shared_ptr< void > > attributes
void getAttribute(const std::function< void(Attribute &)> &onFound, const std::function< void(const std::string &)> &onNotFound, const std::string &subKey="") const
constexpr bool setAttribute(const Attribute &attribute, const std::string &subKey="", bool overwrite=false)
constexpr void getAttribute(const std::function< void(Attribute &)> &onFound, const std::function< void(const std::string &)> &onNotFound) const
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
Timeval(const std::initializer_list< time_t > &initList) noexcept
Definition Timeval.cpp:59
int main(int argc, char *argv[])
std::vector< json > Trace
static void ensureTrace(const std::shared_ptr< express::Request > &req)
static void tracePush(const std::shared_ptr< express::Request > &req, const std::string &label)
static json snapshot(const std::shared_ptr< express::Request > &req, const std::string &label)
static json traceGet(const std::shared_ptr< express::Request > &req)
TickStatus
Definition TickStatus.h:51
State
Definition State.h:51
fixed_string(char const (&)[N]) -> fixed_string< N - 1 >
web::http::server::Server< net::in::stream::legacy::SocketServer > Server
Definition Server.h:54
MountPoint(const std::string &method, const std::string &relativeMountPath)
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