SNode.C
Loading...
Searching...
No Matches
SocketServer.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 NET_IN_STREAM_LEGACY_SOCKETSERVER_H
43#define NET_IN_STREAM_LEGACY_SOCKETSERVER_H
44
45// IWYU pragma: always_keep
46
47#include "core/socket/stream/legacy/SocketAcceptor.h"
48#include "core/socket/stream/legacy/SocketConnection.h" // IWYU pragma: export
49#include "net/in/stream/SocketServer.h" // IWYU pragma: export
50#include "net/in/stream/legacy/config/ConfigSocketServer.h" // IWYU pragma: export
51
52// IWYU pragma: no_include "core/socket/stream/SocketAcceptor.hpp"
53// IWYU pragma: no_include "core/socket/stream/legacy/SocketConnection.hpp"
54// IWYU pragma: no_include "core/socket/stream/SocketConnection.hpp"
55
56#ifndef DOXYGEN_SHOULD_SKIP_THIS
57
58#endif // DOXYGEN_SHOULD_SKIP_THIS
59
60namespace net::in::stream::legacy {
61
62 template <typename SocketContextFactoryT, typename... Args>
66 Args...>;
67
68} // namespace net::in::stream::legacy
69
70extern template class core::socket::Socket<net::in::stream::legacy::config::ConfigSocketServer>;
71extern template class core::socket::stream::legacy::SocketAcceptor<net::in::phy::stream::PhysicalSocketServer,
72 net::in::stream::legacy::config::ConfigSocketServer>;
73extern template class core::socket::stream::legacy::SocketConnection<net::in::phy::stream::PhysicalSocketServer>;
74extern template class core::socket::stream::SocketConnectionT<net::in::phy::stream::PhysicalSocketServer,
75 core::socket::stream::legacy::SocketReader,
76 core::socket::stream::legacy::SocketWriter>;
77
78#endif // NET_IN_STREAM_LEGACY_SOCKETSERVER_H
#define DECLARE_ROOTROUTE_REQUESTMETHOD(METHOD)
Definition RootRoute.h:68
#define DECLARE_ROUTE_REQUESTMETHOD(METHOD)
Definition Route.h:68
#define DEFINE_ROUTE_TEMPLATE_REQUESTMETHOD(METHOD, HTTP_METHOD)
Definition Route.hpp:61
#define DECLARE_ROUTER_REQUESTMETHOD(METHOD)
Definition Router.h:70
#define APPLICATION(req, res)
Definition Router.h:67
#define DEFINE_ROUTER_TEMPLATE_REQUESTMETHOD(METHOD, HTTP_METHOD)
Definition Router.hpp:53
unsigned long lastTick
Definition Controller.h:103
void next(const std::string &how) const
const std::shared_ptr< Request > & getRequest()
RootRoute * rootRoute
Definition Controller.h:96
Controller(const std::shared_ptr< web::http::server::Request > &request, const std::shared_ptr< web::http::server::Response > &response)
bool getStrictRouting() const
void setStrictRouting(bool strictRouting)
std::shared_ptr< Response > response
Definition Controller.h:94
Controller(const Controller &controller)
void setCurrentRoute(Route *currentRoute)
void setRootRoute(RootRoute *rootRoute)
std::shared_ptr< Request > request
Definition Controller.h:93
bool dispatchNext(const std::string &parentMountPath)
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:75
std::string httpVersion
Definition Request.h:97
web::http::CiStringMap< std::string > cookies
Definition Request.h:103
Request(Request &&) noexcept=delete
std::string originalUrl
Definition Request.h:76
const std::string & cookie(const std::string &key) const
Definition Request.cpp:97
std::string url
Definition Request.h:96
Request & operator=(Request &&) noexcept=delete
std::vector< char > body
Definition Request.h:104
const std::string & get(const std::string &key, int i=0) const
Definition Request.cpp:93
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
const std::string & query(const std::string &key) const
Definition Request.cpp:107
web::http::CiStringMap< std::string > headers
Definition Request.h:102
const std::string & param(const std::string &id, const std::string &fallBack="")
Definition Request.cpp:71
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:107
void download(const std::string &file, const std::string &fileName, const std::function< void(int)> &onError)
Definition Response.cpp:77
std::shared_ptr< web::http::server::Response > responseBase
Definition Response.h:96
Response & sendHeader()
Definition Response.cpp:181
Response & attachment(const std::string &fileName="")
Definition Response.cpp:95
Response & cookie(const std::string &name, const std::string &value, const std::map< std::string, std::string > &options={})
Definition Response.cpp:143
Response & clearCookie(const std::string &name, const std::map< std::string, std::string > &options={})
Definition Response.cpp:149
Response(Response &&) noexcept=delete
Response & operator=(Response &&) noexcept=delete
void sendFile(const std::string &file, const std::function< void(int)> &callback)
Definition Response.cpp:177
void redirect(const std::string &loc)
Definition Response.cpp:82
void download(const std::string &file, const std::function< void(int)> &onError)
Definition Response.cpp:73
Response & set(const std::string &field, const std::string &value, bool overwrite=true)
Definition Response.cpp:125
Response & setTrailer(const std::string &field, const std::string &value, bool overwrite=true)
Definition Response.cpp:155
Response & sendFragment(const std::string &chunk)
Definition Response.cpp:193
Response & sendFragment(const char *chunk, std::size_t chunkLen)
Definition Response.cpp:187
Response & append(const std::string &field, const std::string &value)
Definition Response.cpp:119
void send(const std::string &chunk)
Definition Response.cpp:165
Response(const std::shared_ptr< web::http::server::Response > &response) noexcept
Definition Response.cpp:57
void redirect(int state, const std::string &loc)
Definition Response.cpp:86
Response & status(int status)
Definition Response.cpp:113
Response(Response &)=delete
void send(const char *chunk, std::size_t chunkLen)
Definition Response.cpp:161
Response & vary(const std::string &field)
Definition Response.cpp:107
Response & operator=(Response &)=delete
Response & type(const std::string &type)
Definition Response.cpp:137
Response & set(const std::map< std::string, std::string > &headers, bool overwrite=true)
Definition Response.cpp:131
web::http::server::SocketContext * getSocketContext() const
Definition Response.cpp:64
const std::string & header(const std::string &field)
Definition Response.cpp:199
void json(const nlohmann::json &json)
Definition Response.cpp:68
void sendStatus(int state)
Definition Response.cpp:91
void upgrade(const std::shared_ptr< Request > &request, const std::function< void(const std::string)> &status)
Definition Response.cpp:169
Response & location(const std::string &loc)
Definition Response.cpp:101
void dispatch(Controller &&controller)
Definition RootRoute.cpp:95
void dispatch(Controller &controller)
Route & head(const RootRoute &rootRoute) const
Route & del(const RootRoute &rootRoute) const
Route & connect(const RootRoute &rootRoute) const
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
void setStrictRouting(bool strictRouting)
Definition RootRoute.cpp:91
Route & post(const RootRoute &rootRoute) const
Route & put(const RootRoute &rootRoute) const
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
bool dispatch(Controller &controller, const std::string &parentMountPath)
Definition Route.cpp:84
Route & patch(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:109
std::shared_ptr< Dispatcher > dispatcher
Definition Route.h:93
MountPoint mountPoint
Definition Route.h:92
Route & put(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:103
Route & head(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:110
Route & use(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:100
Route & connect(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:106
Route(const std::string &method, const std::string &relativeMountPath, const std::shared_ptr< Dispatcher > &dispatcher)
Definition Route.cpp:75
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:107
bool dispatchNext(Controller &controller, const std::string &parentMountPath)
Definition Route.cpp:96
Route & all(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:101
Route & del(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:105
Route & get(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:102
Route & post(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:104
Route & trace(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &lambda) const
Definition Route.cpp:108
void strictRouting(bool strictRouting=true) const
Definition Router.cpp:78
Route & head(const Router &router) const
Definition Router.cpp:92
Route & all(const Router &router) const
Definition Router.cpp:83
Route & options(const Router &router) const
Definition Router.cpp:89
Route & connect(const Router &router) const
Definition Router.cpp:88
Route & post(const Router &router) const
Definition Router.cpp:86
Route & del(const Router &router) const
Definition Router.cpp:87
Router(const Router &)=default
Route & use(const Router &router) const
Definition Router.cpp:82
Route & get(const Router &router) const
Definition Router.cpp:84
Route & trace(const Router &router) const
Definition Router.cpp:90
Route & patch(const Router &router) const
Definition Router.cpp:91
Route & put(const Router &router) const
Definition Router.cpp:85
std::shared_ptr< RootRoute > rootRoute
Definition Router.h:117
WebAppT(const std::string &name, const Router &router)
Definition WebAppT.h:80
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
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
constexpr bool setAttribute(const Attribute &attribute, const std::string &subKey="", bool overwrite=false)
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[])
Definition Config.h:59
fixed_string(char const (&)[N]) -> fixed_string< N - 1 >
auto operator<=>(const fixed_string &) const =default
constexpr fixed_string(char const *s)
constexpr operator char const *() const