SNode.C
Loading...
Searching...
No Matches
Response.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#ifndef WEB_HTTP_CLIENT_RESPONSE_H
21#define WEB_HTTP_CLIENT_RESPONSE_H
22
23#include "web/http/ConnectionState.h" // IWYU pragma: export
24#include "web/http/CookieOptions.h" // IWYU pragma: export
25
26#ifndef DOXYGEN_SHOULD_SKIP_THIS
27
28#include "web/http/CiStringMap.h" // IWYU pragma: export
29
30#include <cstdint> // IWYU pragma: export
31#include <string>
32#include <vector> // IWYU pragma: export
33
34#endif /* DOXYGEN_SHOULD_SKIP_THIS */
35
36namespace web::http::client {
37
38 class Response {
39 public:
40 Response() = default;
41
42 explicit Response(Response&) = delete;
43 explicit Response(Response&&) noexcept = default;
44
45 Response& operator=(Response&) = delete;
46 Response& operator=(Response&&) noexcept = delete;
47
48 const std::string& get(const std::string& key, int i = 0) const;
49 const std::string& cookie(const std::string& key) const;
50
51 protected:
53
54 public:
55 // Properties
56 std::string httpVersion;
57 std::string statusCode;
58 std::string reason;
59 int httpMajor = 0;
60 int httpMinor = 0;
61
62 CiStringMap<std::string> headers;
63 CiStringMap<CookieOptions> cookies;
64 std::vector<char> body;
65
66 private:
67 std::string nullstr;
68
69 friend class SocketContext;
70
71 friend class ResponseParser;
72 };
73
74} // namespace web::http::client
75
76#endif // WEB_HTTP_CLIENT_RESPONSE_H
Socket & operator=(Socket &&) noexcept=delete
virtual ~Socket()
Definition Socket.hpp:34
Socket & operator=(const Socket &)=default
Socket(const Socket &)=default
Config & getConfig() const
Definition Socket.hpp:38
std::shared_ptr< Config > config
Definition Socket.h:50
Socket(Socket &&) noexcept=delete
Socket(const std::string &name)
Definition Socket.hpp:29
void onReceivedFromPeer(std::size_t available) final
void setTimeout(const utils::Timeval &timeout) final
std::size_t readFromPeer(char *chunk, std::size_t chunkLen) final
const SocketAddress & getRemoteAddress() const final
SocketConnectionT(const std::string &instanceName, PhysicalSocket &&physicalSocket, const std::function< void()> &onDisconnect, const std::string &configuredServer, const SocketAddress &localAddress, const SocketAddress &remoteAddress, const utils::Timeval &readTimeout, const utils::Timeval &writeTimeout, std::size_t readBlockSize, std::size_t writeBlockSize, const utils::Timeval &terminateTimeout)
void doWriteShutdown(const std::function< void()> &onShutdown) override
bool streamToPeer(core::pipe::Source *source) final
void shutdownWrite(bool forceClose) final
void sendToPeer(const char *chunk, std::size_t chunkLen) final
const SocketAddress & getLocalAddress() const final
const std::string & getConfiguredServer() const
virtual void sendToPeer(const char *chunk, std::size_t chunkLen)=0
core::socket::stream::SocketContext * newSocketContext
core::socket::stream::SocketContext * socketContext
void connectSocketContext(const std::shared_ptr< SocketContextFactory > &socketContextFactory)
void switchSocketContext(SocketContext *newSocketContext)
virtual const core::socket::SocketAddress & getLocalAddress() const =0
virtual void setTimeout(const utils::Timeval &timeout)=0
void sentToPeer(const std::vector< uint8_t > &data)
const std::string & getConnectionName() const
void setSocketContext(SocketContext *socketContext)
virtual const core::socket::SocketAddress & getRemoteAddress() const =0
void sendToPeer(const std::string &data)
virtual void shutdownWrite(bool forceClose)=0
virtual std::size_t readFromPeer(char *chunk, std::size_t chunkLen)=0
SocketConnection(const std::string &instanceName, int fd, const std::string &configuredServer)
virtual bool streamToPeer(core::pipe::Source *source)=0
const std::string & getInstanceName() const
SocketConnector(const SocketConnector &socketConnector)
std::function< void(const SocketAddress &, core::socket::State)> onStatus
std::function< void(SocketConnection *)> onConnected
std::shared_ptr< core::socket::stream::SocketContextFactory > socketContextFactory
std::function< void(SocketConnection *)> onDisconnect
std::function< void(SocketConnection *)> onConnect
SocketConnector(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)
SocketConnection(const std::string &instanceName, PhysicalSocket &&physicalSocket, const std::function< void(SocketConnection *)> &onDisconnect, const std::string &configuredServer, const SocketAddress &localAddress, const SocketAddress &remoteAddress, const utils::Timeval &readTimeout, const utils::Timeval &writeTimeout, std::size_t readBlockSize, std::size_t writeBlockSize, const utils::Timeval &terminateTimeout)
SocketConnector(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)
SocketConnector(const SocketConnector &socketConnector)
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)
SocketAddress & setPort(uint16_t port)
SocketAddress(const std::string &ipOrHostname, uint16_t port)
SocketAddress & setHost(const std::string &ipOrHostname)
SocketAddress(uint16_t port)
SocketAddress(const std::string &ipOrHostname)
std::string getHost() const
std::string getCanonName() const
std::shared_ptr< SocketAddrInfo > socketAddrInfo
SocketAddress(const SockAddr &sockAddr, SockLen sockAddrLen, bool numeric=true)
std::string toString(bool expanded=true) const override
void init(const Hints &hints={.aiFlags=0,.aiSockType=0,.aiProtocol=0})
uint16_t getPort() const
ConfigAddressReverse(net::config::ConfigInstance *instance, const std::string &addressOptionName, const std::string &addressOptionDescription)
ConfigAddressReverse & setNumericReverse(bool numeric=true)
SocketAddress getSocketAddress(const SocketAddress::SockAddr &sockAddr, SocketAddress::SockLen sockAddrLen)
SocketAddress getSocketAddress(const SocketAddress::SockAddr &sockAddr, SocketAddress::SockLen sockAddrLen)
ConfigAddress & setPortRequired(bool required=true)
ConfigAddress & setSocketAddress(const SocketAddress &socketAddress)
ConfigAddress(net::config::ConfigInstance *instance, const std::string &addressOptionName, const std::string &addressOptionDescription)
ConfigAddress & setAiSockType(int aiSocktype)
ConfigAddress & setHostRequired(bool required=true)
ConfigAddress & setHost(const std::string &ipOrHostname)
SocketAddress * init() final
ConfigAddress & setAiFlags(int aiFlags)
ConfigAddress & setNumeric(bool numeric=true)
ConfigAddress & setAiProtocol(int aiProtocol)
ConfigAddress & setNumericReverse(bool numeric=true)
ConfigAddress & setPort(uint16_t port)
PhysicalSocket(PhysicalSocket &&) noexcept=default
PhysicalSocket(int type, int protocol)
PhysicalSocketClient(PhysicalSocketClient &&) noexcept=default
PhysicalSocket(PhysicalSocket &&) noexcept=default
void connect(const std::string &ipOrHostname, uint16_t port, const std::string &bindHost, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
void connect(const std::string &ipOrHostname, uint16_t port, const std::string &bindHost, uint16_t bindPort, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
void connect(const std::string &ipOrHostname, uint16_t port, uint16_t bindPort, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
void connect(const std::string &ipOrHostname, uint16_t port, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
ConfigSocketClient(net::config::ConfigInstance *instance)
int getPeerName(typename SocketAddress::SockAddr &remoteSockAddr, typename SocketAddress::SockLen &remoteSockAddrLen)
PhysicalSocket(const PhysicalSocket &)=delete
PhysicalSocket(int domain, int type, int protocol)
int setSockopt(int level, int optname, const void *optval, typename SocketAddress::SockLen optlen) const
int getSockError(int &cErrno) const
PhysicalSocket(PhysicalSocket &&physicalSocket) noexcept=default
PhysicalSocket & operator=(PhysicalSocket &)=delete
PhysicalSocket & operator=(const PhysicalSocket &)=delete
int open(const std::map< int, const PhysicalSocketOption > &socketOptions, Flags flags)
PhysicalSocket(PhysicalSocket &)=delete
int bind(SocketAddress &bindAddress)
PhysicalSocket & operator=(PhysicalSocket &&) noexcept=default
PhysicalSocket(int fd, const SocketAddress &bindAddress)
int getSockName(typename SocketAddress::SockAddr &localSockAddr, typename SocketAddress::SockLen &localSockAddrLen)
SocketAddress getBindAddress() const
int getSockopt(int level, int optname, void *optval, typename SocketAddress::SockLen *optlen) const
int connect(SocketAddress &remoteAddress)
double getMsd() const
Definition Timeval.cpp:167
const timeval * operator&() const
Definition Timeval.cpp:178
bool operator>(const Timeval &timeVal) const
Definition Timeval.cpp:127
friend Timeval operator*(double mul, const Timeval &timeVal)
Definition Timeval.cpp:201
bool operator<(const Timeval &timeVal) const
Definition Timeval.cpp:122
Timeval operator*(double mul) const
Definition Timeval.cpp:94
Timeval(const std::initializer_list< time_t > &initList) noexcept
Definition Timeval.cpp:37
timeval * operator&()
Definition Timeval.cpp:147
Timeval operator-() const
Definition Timeval.cpp:118
static Timeval currentTime()
Definition Timeval.cpp:54
timeval timeVal
Definition Timeval.h:77
bool operator<=(const Timeval &timeVal) const
Definition Timeval.cpp:131
int getMs() const
Definition Timeval.cpp:155
bool operator!=(const Timeval &timeVal) const
Definition Timeval.cpp:143
timespec getTimespec() const
Definition Timeval.cpp:151
Timeval operator-(const Timeval &timeVal) const
Definition Timeval.cpp:85
Timeval & operator=(const timeval &timeVal)
Definition Timeval.cpp:70
Timeval & operator+=(const Timeval &timeVal)
Definition Timeval.cpp:103
bool operator==(const Timeval &timeVal) const
Definition Timeval.cpp:139
Timeval & operator-=(const Timeval &timeVal)
Definition Timeval.cpp:108
Timeval() noexcept
Definition Timeval.cpp:33
Timeval operator+(const Timeval &timeVal) const
Definition Timeval.cpp:76
Timeval & operator=(const Timeval &timeVal)
Definition Timeval.cpp:61
Timeval & operator*=(double mul)
Definition Timeval.cpp:113
bool operator>=(const Timeval &timeVal) const
Definition Timeval.cpp:135
Timeval(double time) noexcept
Definition Timeval.cpp:43
Timeval(const Timeval &timeVal) noexcept=default
Timeval(const timeval &timeVal) noexcept
Definition Timeval.cpp:50
const Timeval & normalize()
Definition Timeval.cpp:182
ParserState parserState
Definition Parser.h:78
std::size_t parse()
Definition Parser.cpp:70
friend enum HTTPCompliance operator&(const enum HTTPCompliance &c1, const enum HTTPCompliance &c2)
Definition Parser.cpp:238
virtual void parseError(int code, const std::string &reason)=0
virtual ~Parser()
Definition Parser.cpp:48
static const std::regex httpVersionRegex
Definition Parser.h:82
friend enum HTTPCompliance operator|(const enum HTTPCompliance &c1, const enum HTTPCompliance &c2)
Definition Parser.cpp:234
std::size_t contentLength
Definition Parser.h:121
virtual void parseStartLine(const std::string &line)=0
std::size_t contentLengthRead
Definition Parser.h:122
web::http::decoder::Fields headerDecoder
Definition Parser.h:108
core::socket::stream::SocketContext * socketContext
Definition Parser.h:105
CiStringMap< std::string > headers
Definition Parser.h:97
std::size_t readContent()
Definition Parser.cpp:197
std::list< web::http::ContentDecoder * > decoderQueue
Definition Parser.h:103
virtual void parsingFinished()=0
virtual void begin()=0
TransferEncoding transferEncoding
Definition Parser.h:80
std::size_t readTrailer()
Definition Parser.cpp:220
std::vector< char > content
Definition Parser.h:98
std::size_t readStartLine()
Definition Parser.cpp:101
virtual void analyzeHeader()
Definition Parser.cpp:138
std::set< std::string > trailerFieldsExpected
Definition Parser.h:110
web::http::decoder::Fields trailerDecoder
Definition Parser.h:111
std::size_t readHeader()
Definition Parser.cpp:125
std::string line
Definition Parser.h:120
void setPipelinedRequests(bool pipelinedRequests)
Definition Client.h:102
Client(std::function< void(const std::shared_ptr< Request > &)> &&onRequestBegin, std::function< void(const std::shared_ptr< Request > &)> &&onRequestEnd)
Definition Client.h:95
Client(const std::string &name, std::function< void(const std::shared_ptr< Request > &)> &&onRequestBegin, std::function< void(const std::shared_ptr< Request > &)> &&onRequestEnd)
Definition Client.h:84
Client(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 > &)> &&onRequestBegin, std::function< void(const std::shared_ptr< Request > &)> &&onRequestEnd)
Definition Client.h:71
Client(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 > &)> &&onRequestBegin, std::function< void(const std::shared_ptr< Request > &)> &&onRequestEnd)
Definition Client.h:54
CiStringMap< std::string > headers
Definition Request.h:150
Request & set(const std::string &field, const std::string &value, bool overwrite=true)
Definition Request.cpp:137
TransferEncoding transferEncoding
Definition Request.h:157
ConnectionState connectionState
Definition Request.h:162
std::size_t contentLengthSent
Definition Request.h:160
void onSourceEof() override
Definition Request.cpp:597
CiStringMap< std::string > cookies
Definition Request.h:151
Request & cookie(const std::string &name, const std::string &value)
Definition Request.cpp:197
Request(Request &&) noexcept
Definition Request.cpp:59
CiStringMap< std::string > trailer
Definition Request.h:152
Request(Request &)=delete
Request & operator=(Request &)=delete
void onSourceError(int errnum) override
Definition Request.cpp:605
std::string header(const std::string &field)
Definition Request.cpp:616
std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> onResponseReceived
Definition Request.h:164
Request & sendFragment(const std::string &data)
Definition Request.cpp:390
bool sendFile(const std::string &file, const std::function< void(int errnum)> &onStatus, const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &onResponseReceived, const std::function< void(const std::shared_ptr< Request > &, const std::string &)> &onResponseParseError=responseParseError)
Definition Request.cpp:352
Request & query(const std::string &key, const std::string &value)
Definition Request.cpp:211
bool upgrade(const std::string &url, const std::string &protocols, const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &onResponseReceived, const std::function< void(const std::shared_ptr< Request > &, const std::string &)> &onResponseParseError=responseParseError)
Definition Request.cpp:279
void onSourceData(const char *chunk, std::size_t chunkLen) override
Definition Request.cpp:593
bool executeSendFragment(const char *chunk, std::size_t chunkLen)
Definition Request.cpp:537
const CiStringMap< std::string > & getQueries() const
Definition Request.cpp:620
const CiStringMap< std::string > & getCookies() const
Definition Request.cpp:628
Request & setTrailer(const std::string &field, const std::string &value, bool overwrite=true)
Definition Request.cpp:217
web::http::client::SocketContext * getSocketContext() const
Definition Request.cpp:632
static void responseParseError(const std::shared_ptr< Request > &request, const std::string &message)
Definition Request.cpp:236
Request & operator=(Request &&) noexcept=delete
void setMasterRequest(const std::shared_ptr< Request > &masterRequest)
Definition Request.cpp:91
std::function< void(const std::shared_ptr< Request > &request, const std::string &message)> onResponseParseError
Definition Request.h:165
CiStringMap< std::string > queries
Definition Request.h:149
std::size_t contentLength
Definition Request.h:159
web::http::client::SocketContext * socketContext
Definition Request.h:169
std::string hostFieldValue
Definition Request.h:142
Request & append(const std::string &field, const std::string &value)
Definition Request.cpp:125
Request & sendFragment(const char *chunk, std::size_t chunkLen)
Definition Request.cpp:380
std::list< RequestCommand * > requestCommands
Definition Request.h:155
bool send(const char *chunk, std::size_t chunkLen, const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &onResponseReceived, const std::function< void(const std::shared_ptr< Request > &, const std::string &)> &onResponseParseError=responseParseError)
Definition Request.cpp:242
const CiStringMap< std::string > & getHeaders() const
Definition Request.cpp:624
Request & host(const std::string &hostFieldValue)
Definition Request.cpp:119
bool send(const std::string &chunk, const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &onResponseReceived, const std::function< void(const std::shared_ptr< Request > &, const std::string &)> &onResponseParseError=responseParseError)
Definition Request.cpp:269
std::weak_ptr< Request > masterRequest
Definition Request.h:167
Request & type(const std::string &type)
Definition Request.cpp:191
bool end(const std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> &onResponseReceived, const std::function< void(const std::shared_ptr< Request > &, const std::string &)> &onResponseParseError=responseParseError)
Definition Request.cpp:394
void deliverResponseParseError(const std::shared_ptr< Request > &request, const std::string &message)
Definition Request.cpp:562
bool executeSendFile(const std::string &file, const std::function< void(int)> &onStatus)
Definition Request.cpp:439
bool executeUpgrade(const std::string &url, const std::string &protocols)
Definition Request.cpp:481
std::function< void(Response &&)> onResponseParsed
ResponseParser(core::socket::stream::SocketContext *socketContext, const std::function< void()> &onResponseStart, const std::function< void(Response &&)> &onResponseParsed, const std::function< void(int, const std::string &)> &onResponseParseError)
ResponseParser & operator=(const ResponseParser &)=delete
void parseError(int code, const std::string &reason) override
void parseStartLine(const std::string &line) override
ResponseParser(const ResponseParser &)=delete
std::function< void()> onResponseStart
std::function< void(int, const std::string &)> onResponseParseError
SocketContextFactory(const std::function< void(const std::shared_ptr< Request > &)> &onRequestBegin, const std::function< void(const std::shared_ptr< Request > &)> &onRequestEnd, const std::function< net::config::ConfigInstance &()> &getConfigInstance)
std::function< void(const std::shared_ptr< Request > &)> onRequestBegin
void setPipelinedRequests(bool pipelinedRequests)
std::function< void(const std::shared_ptr< Request > &)> onRequestEnd
core::socket::stream::SocketContext * create(core::socket::stream::SocketConnection *socketConnection) override
SocketContext(core::socket::stream::SocketConnection *socketConnection, const std::function< void(const std::shared_ptr< Request > &)> &onRequestBegin, const std::function< void(const std::shared_ptr< Request > &)> &onRequestEnd, bool pipelinedRequests)
void requestPrepared(Request &&request)
std::list< Request > deliveredRequests
void requestDelivered(Request &&request, bool success)
void deliverResponseParseError(int status, const std::string &reason)
std::shared_ptr< Request > currentRequest
std::size_t onReceivedFromPeer() override
std::function< void(const std::shared_ptr< Request > &)> onRequestBegin
void deliverResponse(Response &&response)
void onWriteError(int errnum) override
bool onSignal(int signum) override
void initiateRequest(Request &request)
std::function< void(const std::shared_ptr< Request > &)> onRequestEnd
void responseDelivered(bool httpClose)
std::list< Request > pendingRequests
std::shared_ptr< Request > masterRequest
int main(int argc, char *argv[])
Definition Config.h:37