SNode.C
Loading...
Searching...
No Matches
ConnectionState.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_CONNECTIONSTATE_H
43#define WEB_HTTP_CONNECTIONSTATE_H
44
45#ifndef DOXYGEN_SHOULD_SKIP_THIS
46
47#endif /* DOXYGEN_SHOULD_SKIP_THIS */
48
49namespace web::http {
50
52
53} // namespace web::http
54
55#endif // WEB_HTTP_CONNECTIONSTATE_H
Socket & operator=(Socket &&) noexcept=delete
virtual ~Socket()
Definition Socket.hpp:56
Socket & operator=(const Socket &)=default
Socket(const Socket &)=default
Config & getConfig() const
Definition Socket.hpp:60
std::shared_ptr< Config > config
Definition Socket.h:72
Socket(Socket &&) noexcept=delete
Socket(const std::string &name)
Definition Socket.hpp:51
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 & setDisableNagleAlgorithm(bool disableNagleAlgorithm=true)
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 open(const std::map< int, std::map< int, const PhysicalSocketOption > > &socketOptionsMapMap, Flags flags)
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
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:189
const timeval * operator&() const
Definition Timeval.cpp:200
bool operator>(const Timeval &timeVal) const
Definition Timeval.cpp:149
friend Timeval operator*(double mul, const Timeval &timeVal)
Definition Timeval.cpp:223
bool operator<(const Timeval &timeVal) const
Definition Timeval.cpp:144
Timeval operator*(double mul) const
Definition Timeval.cpp:116
Timeval(const std::initializer_list< time_t > &initList) noexcept
Definition Timeval.cpp:59
timeval * operator&()
Definition Timeval.cpp:169
Timeval operator-() const
Definition Timeval.cpp:140
static Timeval currentTime()
Definition Timeval.cpp:76
timeval timeVal
Definition Timeval.h:99
bool operator<=(const Timeval &timeVal) const
Definition Timeval.cpp:153
int getMs() const
Definition Timeval.cpp:177
bool operator!=(const Timeval &timeVal) const
Definition Timeval.cpp:165
timespec getTimespec() const
Definition Timeval.cpp:173
Timeval operator-(const Timeval &timeVal) const
Definition Timeval.cpp:107
Timeval & operator=(const timeval &timeVal)
Definition Timeval.cpp:92
Timeval & operator+=(const Timeval &timeVal)
Definition Timeval.cpp:125
bool operator==(const Timeval &timeVal) const
Definition Timeval.cpp:161
Timeval & operator-=(const Timeval &timeVal)
Definition Timeval.cpp:130
Timeval() noexcept
Definition Timeval.cpp:55
Timeval operator+(const Timeval &timeVal) const
Definition Timeval.cpp:98
Timeval & operator=(const Timeval &timeVal)
Definition Timeval.cpp:83
Timeval & operator*=(double mul)
Definition Timeval.cpp:135
bool operator>=(const Timeval &timeVal) const
Definition Timeval.cpp:157
Timeval(double time) noexcept
Definition Timeval.cpp:65
Timeval(const Timeval &timeVal) noexcept=default
Timeval(const timeval &timeVal) noexcept
Definition Timeval.cpp:72
const Timeval & normalize()
Definition Timeval.cpp:204
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:106
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:93
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:76
Client(std::function< void(const std::shared_ptr< Request > &)> &&onRequestBegin, std::function< void(const std::shared_ptr< Request > &)> &&onRequestEnd)
Definition Client.h:117
void setPipelinedRequests(bool pipelinedRequests)
Definition Client.h:124
CiStringMap< std::string > headers
Definition Request.h:172
Request & set(const std::string &field, const std::string &value, bool overwrite=true)
Definition Request.cpp:159
TransferEncoding transferEncoding
Definition Request.h:179
ConnectionState connectionState
Definition Request.h:184
std::size_t contentLengthSent
Definition Request.h:182
void onSourceEof() override
Definition Request.cpp:619
CiStringMap< std::string > cookies
Definition Request.h:173
Request & cookie(const std::string &name, const std::string &value)
Definition Request.cpp:219
Request(Request &&) noexcept
Definition Request.cpp:81
CiStringMap< std::string > trailer
Definition Request.h:174
Request(Request &)=delete
Request & operator=(Request &)=delete
void onSourceError(int errnum) override
Definition Request.cpp:627
std::string header(const std::string &field)
Definition Request.cpp:638
std::function< void(const std::shared_ptr< Request > &, const std::shared_ptr< Response > &)> onResponseReceived
Definition Request.h:186
Request & sendFragment(const std::string &data)
Definition Request.cpp:412
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:374
Request & query(const std::string &key, const std::string &value)
Definition Request.cpp:233
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:301
void onSourceData(const char *chunk, std::size_t chunkLen) override
Definition Request.cpp:615
bool executeSendFragment(const char *chunk, std::size_t chunkLen)
Definition Request.cpp:559
const CiStringMap< std::string > & getQueries() const
Definition Request.cpp:642
const CiStringMap< std::string > & getCookies() const
Definition Request.cpp:650
Request & setTrailer(const std::string &field, const std::string &value, bool overwrite=true)
Definition Request.cpp:239
web::http::client::SocketContext * getSocketContext() const
Definition Request.cpp:654
static void responseParseError(const std::shared_ptr< Request > &request, const std::string &message)
Definition Request.cpp:258
Request & operator=(Request &&) noexcept=delete
void setMasterRequest(const std::shared_ptr< Request > &masterRequest)
Definition Request.cpp:113
std::function< void(const std::shared_ptr< Request > &request, const std::string &message)> onResponseParseError
Definition Request.h:187
CiStringMap< std::string > queries
Definition Request.h:171
std::size_t contentLength
Definition Request.h:181
web::http::client::SocketContext * socketContext
Definition Request.h:191
std::string hostFieldValue
Definition Request.h:164
Request & append(const std::string &field, const std::string &value)
Definition Request.cpp:147
Request & sendFragment(const char *chunk, std::size_t chunkLen)
Definition Request.cpp:402
std::list< RequestCommand * > requestCommands
Definition Request.h:177
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:264
const CiStringMap< std::string > & getHeaders() const
Definition Request.cpp:646
Request & host(const std::string &hostFieldValue)
Definition Request.cpp:141
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:291
std::weak_ptr< Request > masterRequest
Definition Request.h:189
Request & type(const std::string &type)
Definition Request.cpp:213
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:416
void deliverResponseParseError(const std::shared_ptr< Request > &request, const std::string &message)
Definition Request.cpp:584
bool executeSendFile(const std::string &file, const std::function< void(int)> &onStatus)
Definition Request.cpp:461
bool executeUpgrade(const std::string &url, const std::string &protocols)
Definition Request.cpp:503
std::function< void(const std::shared_ptr< Request > &)> onRequestEnd
core::socket::stream::SocketContext * create(core::socket::stream::SocketConnection *socketConnection) override
void setPipelinedRequests(bool pipelinedRequests)
std::function< void(const std::shared_ptr< Request > &)> onRequestBegin
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)
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:59