SNode.C
Loading...
Searching...
No Matches
Server.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 WEB_HTTP_SERVER_SERVERT_H
43#define WEB_HTTP_SERVER_SERVERT_H
44
45#include "web/http/server/SocketContextFactory.h" // IWYU pragma: export
46
47#ifndef DOXYGEN_SHOULD_SKIP_THIS
48
49#include <functional>
50#include <string>
51
52#endif // DOXYGEN_SHOULD_SKIP_THIS
53
54namespace web::http::server {
55
56 template <template <typename SocketContextFactoryT, typename... Args> typename SocketServerT>
57 class Server
58 : public SocketServerT<web::http::server::SocketContextFactory,
59 std::function<void(const std::shared_ptr<web::http::server::Request>&,
60 const std::shared_ptr<web::http::server::Response>&)>> { // this makes
61 // it an
62 // HTTP server
63 public:
64 using Request = web::http::server::Request;
65 using Response = web::http::server::Response;
66
67 private:
68 using Super = SocketServerT<web::http::server::SocketContextFactory,
69 std::function<void(const std::shared_ptr<Request>&, const std::shared_ptr<Response>&)>>;
70
71 public:
72 using SocketConnection = typename Super::SocketConnection;
73 using SocketAddress = typename SocketConnection::SocketAddress;
74
75 Server(const std::string& name,
76 const std::function<void(SocketConnection*)>& onConnect,
77 const std::function<void(SocketConnection*)>& onConnected,
78 const std::function<void(SocketConnection*)>& onDisconnect,
79 std::function<void(const std::shared_ptr<Request>&, const std::shared_ptr<Response>&)>&& onRequestReady)
80 : Super(name, onConnect, onConnected, onDisconnect, std::forward<decltype(onRequestReady)>(onRequestReady)) {
81 }
82
83 Server(const std::function<void(SocketConnection*)>& onConnect,
84 const std::function<void(SocketConnection*)>& onConnected,
85 const std::function<void(SocketConnection*)>& onDisconnect,
86 std::function<void(const std::shared_ptr<Request>&, const std::shared_ptr<Response>&)>&& onRequestReady)
87 : Server("", onConnect, onConnected, onDisconnect, std::forward<decltype(onRequestReady)>(onRequestReady)) {
88 }
89
90 Server(const std::string& name,
91 std::function<void(const std::shared_ptr<Request>&, const std::shared_ptr<Response>&)>&& onRequestReady)
92 : Super(name, std::forward<decltype(onRequestReady)>(onRequestReady)) {
93 }
94
95 explicit Server(const std::function<void(const std::shared_ptr<Request>&, std::shared_ptr<Response>&)>&& onRequestReady)
96 : Server("", std::forward<decltype(onRequestReady)>(onRequestReady)) {
97 }
98 };
99
100} // namespace web::http::server
101
102#endif // WEB_HTTP_SERVER_SERVERT_H
#define APPLICATION(req, res)
Definition Router.h:68
static State state()
Definition SNodeC.cpp:76
AcceptEventReceiver(const std::string &name, const utils::Timeval &timeout)
Config & getConfig() const
Definition Socket.hpp:60
State & operator&=(int state)
Definition State.cpp:90
static constexpr int DISABLED
Definition State.h:56
bool operator==(const int &state) const
Definition State.cpp:74
State operator&(int state)
Definition State.cpp:106
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
static constexpr int NO_RETRY
Definition State.h:59
SocketAcceptor(const std::shared_ptr< core::socket::stream::SocketContextFactory > &socketContextFactory, const std::function< void(SocketConnection *)> &onConnect, const std::function< void(SocketConnection *)> &onConnected, const std::function< void(SocketConnection *)> &onDisconnect, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus, const std::shared_ptr< Config > &config)
std::function< void(SocketConnection *)> onConnected
SocketAcceptor(const SocketAcceptor &socketAcceptor)
std::function< void(SocketConnection *)> onConnect
std::function< void(SocketConnection *)> onDisconnect
std::shared_ptr< core::socket::stream::SocketContextFactory > socketContextFactory
std::shared_ptr< Config > config
PhysicalServerSocket physicalServerSocket
std::function< void(const SocketAddress &, core::socket::State)> onStatus
std::function< void(SocketConnection *)> setOnConnected(const std::function< void(SocketConnection *)> &onConnected)
void realListen(const std::function< void(const SocketAddress &, core::socket::State)> &onStatus, unsigned int tries, double retryTimeoutScale) const
SocketServer(const std::string &name, const std::function< void(SocketConnection *)> &onConnect, const std::function< void(SocketConnection *)> &onConnected, const std::function< void(SocketConnection *)> &onDisconnect, Args &&... args)
SocketServer(const std::string &name, Args &&... args)
std::function< void(SocketConnection *)> onConnect
SocketServer(const std::function< void(SocketConnection *)> &onConnect, const std::function< void(SocketConnection *)> &onConnected, const std::function< void(SocketConnection *)> &onDisconnect, Args &&... args)
std::function< void(SocketConnection *)> onDisconnect
void listen(const SocketAddress &localAddress, int backlog, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
void listen(const SocketAddress &localAddress, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
std::shared_ptr< SocketContextFactory > socketContextFactory
std::function< void(SocketConnection *)> setOnConnect(const std::function< void(SocketConnection *)> &onConnect)
void listen(const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
std::function< void(SocketConnection *)> onConnected
std::shared_ptr< SocketContextFactory > getSocketContextFactory()
std::function< void(SocketConnection *)> setOnDisconnect(const std::function< void(SocketConnection *)> &onDisconnect)
SocketAcceptor(const SocketAcceptor &socketAcceptor)
SocketAcceptor(const std::shared_ptr< core::socket::stream::SocketContextFactory > &socketContextFactory, const std::function< void(SocketConnection *)> &onConnect, const std::function< void(SocketConnection *)> &onConnected, const std::function< void(SocketConnection *)> &onDisconnect, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus, const std::shared_ptr< Config > &config)
static Timer singleshotTimer(const std::function< void()> &dispatcher, const utils::Timeval &timeout)
Definition Timer.cpp:57
Controller(const std::shared_ptr< web::http::server::Request > &request, const std::shared_ptr< web::http::server::Response > &response)
void send(const std::string &chunk)
Definition Response.cpp:165
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
const std::string & getInstanceName() const
ConfigPhysicalSocketServer & setAcceptTimeout(const utils::Timeval &acceptTimeout)
ConfigPhysicalSocketServer & setBacklog(int newBacklog)
ConfigPhysicalSocketServer & setAcceptsPerTick(int acceptsPerTickSet)
ConfigSocketServer(net::config::ConfigInstance *instance)
std::string toString(bool expanded=true) const override
PhysicalSocketServer(PhysicalSocketServer &&) noexcept=default
void listen(const std::string &ipOrHostname, uint16_t port, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
void listen(uint16_t port, int backlog, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
void listen(const std::string &ipOrHostname, uint16_t port, int backlog, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
void listen(uint16_t port, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
ConfigSocketServer & setReusePort(bool reusePort=true)
ConfigSocketServer & setReuseAddress(bool reuseAddress=true)
ConfigSocketServer(net::config::ConfigInstance *instance)
ConfigSocketServer & setDisableNagleAlgorithm(bool disableNagleAlgorithm=true)
void getAttribute(const std::function< void(Attribute &)> &onFound, const std::function< void(const std::string &)> &onNotFound, const std::string &subKey="") const
static double getInRange(double ll, double ul)
Definition Random.cpp:52
Timeval(const std::initializer_list< time_t > &initList) noexcept
Definition Timeval.cpp:59
void onSourceData(const char *chunk, std::size_t chunkLen) override
Definition Response.cpp:430
Response(SocketContext *socketContext)
Definition Response.cpp:72
Response & operator=(Response &&) noexcept=delete
SocketContext * getSocketContext() const
Definition Response.cpp:457
SocketContext * socketContext
Definition Response.h:137
void onSourceConnect(core::pipe::Source *source) override
Definition Response.cpp:416
web::http::CiStringMap< web::http::CookieOptions > cookies
Definition Response.h:130
Response & status(int statusCode)
Definition Response.cpp:102
void send(const std::string &chunk)
Definition Response.cpp:224
Response(Response &&) noexcept=delete
void send(const char *chunk, std::size_t chunkLen)
Definition Response.cpp:213
Response & setTrailer(const std::string &field, const std::string &value, bool overwrite=true)
Definition Response.cpp:194
Response & set(const std::map< std::string, std::string > &headers, bool overwrite=true)
Definition Response.cpp:120
web::http::CiStringMap< std::string > trailer
Definition Response.h:131
web::http::CiStringMap< std::string > headers
Definition Response.h:129
Response & set(const std::string &field, const std::string &value, bool overwrite=true)
Definition Response.cpp:128
TransferEncoding transferEncoding
Definition Response.h:141
void upgrade(const std::shared_ptr< Request > &request, const std::function< void(const std::string &)> &status)
Definition Response.cpp:244
Response & type(const std::string &type)
Definition Response.cpp:174
void onSourceError(int errnum) override
Definition Response.cpp:442
Response(Response &)=delete
core::socket::stream::SocketContext * socketContextUpgrade
Definition Response.h:138
Response & sendFragment(const std::string &chunk)
Definition Response.cpp:389
Response & cookie(const std::string &name, const std::string &value, const std::map< std::string, std::string > &options={})
Definition Response.cpp:178
Response & operator=(Response &)=delete
Response & append(const std::string &field, const std::string &value)
Definition Response.cpp:108
void sendStatus(int statusCode)
Definition Response.cpp:232
Response & sendFragment(const char *chunk, std::size_t chunkLen)
Definition Response.cpp:371
void onSourceEof() override
Definition Response.cpp:434
void sendFile(const std::string &file, const std::function< void(int)> &callback)
Definition Response.cpp:292
Response & clearCookie(const std::string &name, const std::map< std::string, std::string > &options={})
Definition Response.cpp:184
ConnectionState connectionState
Definition Response.h:140
const std::string & header(const std::string &field)
Definition Response.cpp:453
Server(const std::string &name, std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &&onRequestReady)
Definition Server.h:90
Server(const std::string &name, const std::function< void(SocketConnection *)> &onConnect, const std::function< void(SocketConnection *)> &onConnected, const std::function< void(SocketConnection *)> &onDisconnect, std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &&onRequestReady)
Definition Server.h:75
Server(const std::function< void(SocketConnection *)> &onConnect, const std::function< void(SocketConnection *)> &onConnected, const std::function< void(SocketConnection *)> &onDisconnect, std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &&onRequestReady)
Definition Server.h:83
Server(const std::function< void(const std::shared_ptr< Request > &, std::shared_ptr< Response > &)> &&onRequestReady)
Definition Server.h:95
int main(int argc, char *argv[])
Definition Timer.h:59
TickStatus
Definition TickStatus.h:51
State
Definition State.h:51
Definition Client.h:52