SNode.C
Loading...
Searching...
No Matches
ConfigAddress.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_CONFIG_CONFIGADDRESS_H
43#define NET_CONFIG_CONFIGADDRESS_H
44
45#include "net/config/ConfigAddressBase.h" // IWYU pragma: export
46
47namespace net::config {
48 class ConfigInstance;
49}
50
51#ifndef DOXYGEN_SHOULD_SKIP_THIS
52
53namespace CLI {
54 class Option;
55} // namespace CLI
56
57#endif // DOXYGEN_SHOULD_SKIP_THIS
58
59namespace net::config {
60
61 template <typename SocketAddressT>
62 class ConfigAddress : public ConfigAddressBase<SocketAddressT> {
63 private:
64 using Super = ConfigAddressBase<SocketAddressT>;
65 using SocketAddress = SocketAddressT;
66
67 protected:
68 ConfigAddress(ConfigInstance* instance, const std::string& addressOptionName, const std::string& addressOptionDescription);
69
70 ~ConfigAddress() override;
71
72 public:
73 using Super::getSocketAddress;
74 SocketAddress& getSocketAddress();
75 void renew();
76
77 private:
78 virtual SocketAddress* init() = 0;
79
80 SocketAddress* socketAddress = nullptr;
81 };
82
83} // namespace net::config
84
85#endif // NET_CONFIG_CONFIGADDRESS_H
core::socket::stream::SocketContext * create(core::socket::stream::SocketConnection *socketConnection) override
web::http::client::ResponseParser * responseParser
SimpleSocketProtocol(core::socket::stream::SocketConnection *socketConnection)
void onReadError(int errnum) override
void onWriteError(int errnum) override
std::size_t onReceivedFromPeer() override
virtual void timeoutEvent()=0
DescriptorEventReceiver(const std::string &name, DescriptorEventPublisher &descriptorEventPublisher, const utils::Timeval &timeout=TIMEOUT::DISABLE)
void triggered(const utils::Timeval &currentTime)
virtual void dispatchEvent()=0
DescriptorEventPublisher & descriptorEventPublisher
void setEnabled(const utils::Timeval &currentTime)
void onEvent(const utils::Timeval &currentTime) final
void setTimeout(const utils::Timeval &timeout)
virtual void signalEvent(int signum)=0
void checkTimeout(const utils::Timeval &currentTime)
utils::Timeval getTimeout(const utils::Timeval &currentTime) const
virtual ~Descriptor()
Descriptor(Descriptor &&descriptor) noexcept
Descriptor & operator=(const Descriptor &descriptor)=delete
Descriptor & operator=(int fd)
Descriptor & operator=(Descriptor &&descriptor) noexcept
int getFd() const
Descriptor(const Descriptor &d)=delete
Descriptor()=delete
const std::string & getName() const
virtual void destruct()
static void atNextTick(const std::function< void(void)> &callBack)
virtual void onEvent(const utils::Timeval &currentTime)=0
EventReceiver & operator=(EventReceiver &&)=delete
virtual ~EventReceiver()=default
EventReceiver(EventReceiver &)=delete
EventReceiver(const std::string &name)
EventReceiver(EventReceiver &&)=delete
EventReceiver & operator=(EventReceiver &)=delete
bool published
Definition Event.h:83
void span()
Definition Event.cpp:64
const std::string & getName() const
Definition Event.cpp:78
void dispatch(const utils::Timeval &currentTime)
Definition Event.cpp:82
EventMultiplexer & eventMultiplexer
Definition Event.h:81
EventReceiver * eventReceiver
Definition Event.h:80
std::string name
Definition Event.h:78
Event(EventReceiver *eventReceiver, const std::string &name)
Definition Event.cpp:54
EventReceiver * getEventReceiver() const
Definition Event.cpp:87
void relax()
Definition Event.cpp:71
Observer(Observer &&)=delete
Observer()=default
Observer(Observer &)=delete
virtual void unobservedEvent()=0
static void init(int argc, char *argv[])
Definition SNodeC.cpp:54
static State state()
Definition SNodeC.cpp:76
static int start(const utils::Timeval &timeOut={LONG_MAX, 0})
Definition SNodeC.cpp:60
ConnectEventReceiver(const std::string &name, const utils::Timeval &timeout)
ReadEventReceiver(const std::string &name, const utils::Timeval &timeout)
WriteEventReceiver(const std::string &name, const utils::Timeval &timeout)
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
State & operator^=(int state)
Definition State.cpp:96
State & operator&=(int state)
Definition State.cpp:90
operator int() const
Definition State.cpp:70
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
State & operator=(int state)
Definition State.cpp:78
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
State(const int &state, const std::string &file, const int &line)
Definition State.cpp:54
std::string errstr
Definition State.h:95
State operator^(int state)
Definition State.cpp:110
State(const int &state, const std::string &file, const int &line, int errnum, const std::string &errstr)
Definition State.cpp:62
std::string where() const
Definition State.cpp:134
static constexpr int NO_RETRY
Definition State.h:59
State operator|(int state)
Definition State.cpp:102
std::string file
Definition State.h:91
State & operator|=(int state)
Definition State.cpp:84
SocketClient(const std::string &name, const std::function< void(SocketConnection *)> &onConnect, const std::function< void(SocketConnection *)> &onConnected, const std::function< void(SocketConnection *)> &onDisconnect, Args &&... args)
void connect(const SocketAddress &remoteAddress, const SocketAddress &localAddress, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
const std::shared_ptr< SocketContextFactory > socketContextFactory
std::function< void(SocketConnection *)> setOnConnect(const std::function< void(SocketConnection *)> &onConnect)
std::function< void(SocketConnection *)> setOnDisconnect(const std::function< void(SocketConnection *)> &onDisconnect)
SocketClient(const std::string &name, Args &&... args)
void connect(const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
std::function< void(SocketConnection *)> onConnect
std::shared_ptr< SocketContextFactory > getSocketContextFactory() const
SocketClient(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 connect(const SocketAddress &remoteAddress, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
std::function< void(SocketConnection *)> setOnConnected(const std::function< void(SocketConnection *)> &onConnected)
std::function< void(SocketConnection *)> onConnected
void realConnect(const std::function< void(const SocketAddress &, core::socket::State)> &onStatus, unsigned int tries, double retryTimeoutScale) const
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< char > &data)
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)
SocketContext(core::socket::stream::SocketConnection *socketConnection)
void onReadError(int errnum) override
void shutdownWrite(bool forceClose=false)
void onWriteError(int errnum) override
void signalEvent(int sigNum) final
SocketReader(const std::string &instanceName, const std::function< void(int)> &onStatus, const utils::Timeval &timeout, std::size_t blockSize, const utils::Timeval &terminateTimeout)
std::size_t readFromPeer(char *chunk, std::size_t chunkLen)
void setBlockSize(std::size_t readBlockSize)
virtual void onReceivedFromPeer(std::size_t available)=0
virtual ssize_t read(char *chunk, std::size_t chunkLen)
std::function< void(int)> onStatus
virtual void doWriteShutdown(const std::function< void()> &onShutdown)=0
std::function< void(int)> onStatus
void setBlockSize(std::size_t writeBlockSize)
void sendToPeer(const char *chunk, std::size_t chunkLen)
void signalEvent(int sigNum) final
std::function< void()> onShutdown
virtual bool onSignal(int sigNum)=0
void shutdownWrite(const std::function< void()> &onShutdown)
bool streamToPeer(core::pipe::Source *source)
virtual ssize_t write(const char *chunk, std::size_t chunkLen)
SocketWriter(const std::string &instanceName, const std::function< void(int)> &onStatus, const utils::Timeval &timeout, std::size_t blockSize, const utils::Timeval &terminateTimeout)
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)
static Timer singleshotTimer(const std::function< void()> &dispatcher, const utils::Timeval &timeout)
Definition Timer.cpp:57
SocketAddress(const SockAddr &sockAddr, SockLen sockAddrLen)
const SockLen & getSockAddrLen() const
SocketAddress & operator=(const SocketAddress &socketAddress)
SocketAddress(const SocketAddress &socketAddress)
SocketAddress(sa_family_t af, SockLen sockAddrLen=sizeof(SockAddr))
const sockaddr & getSockAddr()
sa_family_t getAddressFamily() const
SocketAddress * socketAddress
SocketAddress & getSocketAddress()
ConfigAddress(ConfigInstance *instance, const std::string &addressOptionName, const std::string &addressOptionDescription)
virtual SocketAddress * init()=0
CLI::App * getSection(const std::string &name) const
ConfigInstance(ConfigInstance &&)=delete
void setDisabled(bool disabled=true)
void setInstanceName(const std::string &instanceName)
ConfigInstance(ConfigInstance &)=delete
ConfigInstance(const std::string &instanceName, Role role)
static const std::string nameAnonymous
ConfigInstance & operator=(ConfigInstance &)=delete
CLI::App * addSection(const std::string &name, const std::string &description)
const std::string & getInstanceName() const
ConfigInstance & operator=(ConfigInstance &&)=delete
void required(CLI::App *section, bool req=true)
ConfigLegacy(ConfigInstance *instance)
CLI::Option * addOption(const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &additionalValidator)
ConfigSection(ConfigInstance *instance, const std::string &name, const std::string &description)
CLI::Option * addOption(const std::string &name, const std::string &description, const std::string &typeName)
CLI::Option * addOption(const std::string &name, const std::string &description)
CLI::Option * addOption(const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue)
ConfigSection(const ConfigSection &)=delete
ConfigSection & operator=(ConfigSection &&)=delete
CLI::Option * addFlag(const std::string &name, const std::string &description, const std::string &typeName, const CLI::Validator &additionalValidator)
CLI::Option * addOption(const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &additionalValidator)
CLI::Option * addFlagFunction(const std::string &name, const std::function< void()> &callback, const std::string &description, const std::string &typeName, const std::string &defaultValue)
CLI::Option * addFlag(const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue)
CLI::Option * addFlag(const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue, const CLI::Validator &additionalValidator)
ConfigSection(ConfigSection &&)=delete
CLI::Option * addFlagFunction(const std::string &name, const std::function< void()> &callback, const std::string &description, const std::string &typeName, const std::string &defaultValue, const CLI::Validator &validator)
ConfigSection & operator=(const ConfigSection &)=delete
CLI::Option * addFlag(const std::string &name, const std::string &description, const std::string &typeName)
void required(CLI::Option *opt, bool req=true)
ConfigSocketClient(net::config::ConfigInstance *instance)
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
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)
PhysicalSocketOption(int optLevel, int optName, int optValue)
PhysicalSocketOption(int optLevel, int optName, const std::vector< char > &optValue)
PhysicalSocketOption(int optLevel, int optName, const std::string &optValue)
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)
static double getInRange(double ll, double ul)
Definition Random.cpp:52
std::size_t parse()
Definition Parser.cpp:92
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)
int main(int argc, char *argv[])
static web::http::client::ResponseParser * getResponseParser(core::socket::stream::SocketContext *socketContext)
Definition Timer.h:59
State
Definition State.h:51
State eventLoopState()
Definition State.cpp:52
SocketClient getLegacyClient()
SocketClient getClient()