SNode.C
Loading...
Searching...
No Matches
SocketConnector.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 CORE_SOCKET_STREAM_SOCKETCONNECTOR_H
21#define CORE_SOCKET_STREAM_SOCKETCONNECTOR_H
22
23#include "core/eventreceiver/ConnectEventReceiver.h"
24#include "core/socket/State.h"
25
26namespace core::socket::stream {
27 class SocketContextFactory;
28}
29
30#ifndef DOXYGEN_SHOULD_SKIP_THIS
31
32#include <functional>
33#include <memory>
34
35#endif /* DOXYGEN_SHOULD_SKIP_THIS */
36
37namespace core::socket::stream {
38
39 template <typename PhysicalSocketClientT, typename ConfigT, template <typename PhysicalSocketClient> typename SocketConnectionT>
40 class SocketConnector : protected core::eventreceiver::ConnectEventReceiver {
41 private:
42 using PhysicalClientSocket = PhysicalSocketClientT;
43
44 protected:
45 using Config = ConfigT;
46 using SocketAddress = typename PhysicalClientSocket::SocketAddress;
47 using SocketConnection = SocketConnectionT<PhysicalClientSocket>;
48
49 public:
50 SocketConnector(const std::shared_ptr<core::socket::stream::SocketContextFactory>& socketContextFactory,
51 const std::function<void(SocketConnection*)>& onConnect,
52 const std::function<void(SocketConnection*)>& onConnected,
53 const std::function<void(SocketConnection*)>& onDisconnect,
54 const std::function<void(const SocketAddress&, core::socket::State)>& onStatus,
55 const std::shared_ptr<Config>& config);
56
57 SocketConnector(const SocketConnector& socketConnector);
58
59 ~SocketConnector() override;
60
61 protected:
62 virtual void useNextSocketAddress() = 0;
63
64 virtual void init();
65
66 private:
67 void connectEvent() final;
68
69 void unobservedEvent() final;
70 void connectTimeout() final;
71
72 protected:
73 void destruct() final;
74
75 private:
76 PhysicalClientSocket physicalClientSocket;
77 SocketAddress remoteAddress;
78
79 protected:
80 std::shared_ptr<core::socket::stream::SocketContextFactory> socketContextFactory = nullptr;
81
85
87
88 std::shared_ptr<Config> config = nullptr;
89 };
90
91} // namespace core::socket::stream
92
93#endif // CORE_SOCKET_STREAM_SOCKETCONNECTOR_H
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)
int main(int argc, char *argv[])
Definition Config.h:37