SNode.C
Loading...
Searching...
No Matches
core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args > Class Template Reference

#include <SocketServer.h>

Inheritance diagram for core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >:
Collaboration diagram for core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >:

Public Types

using SocketConnection = typename SocketAcceptor::SocketConnection
 
using SocketAddress = typename SocketAcceptor::SocketAddress
 
using Config = typename SocketAcceptor::Config
 
- Public Types inherited from core::socket::Socket< SocketAcceptorT::Config >
using Config = SocketAcceptorT::Config
 

Public Member Functions

 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::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)
 
 SocketServer (Args &&... args)
 
void listen (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
 
void listen (const SocketAddress &localAddress, int backlog, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
 
std::function< void(SocketConnection *)> & getOnConnect ()
 
std::function< void(SocketConnection *)> setOnConnect (const std::function< void(SocketConnection *)> &onConnect, bool initialize=false)
 
std::function< void(SocketConnection *)> & getOnConnected ()
 
std::function< void(SocketConnection *)> setOnConnected (const std::function< void(SocketConnection *)> &onConnected, bool initialize=false)
 
std::function< void(SocketConnection *)> & getOnDisconnect ()
 
std::function< void(SocketConnection *)> setOnDisconnect (const std::function< void(SocketConnection *)> &onDisconnect, bool initialize=false)
 
std::shared_ptr< SocketContextFactorygetSocketContextFactory ()
 
- Public Member Functions inherited from core::socket::Socket< SocketAcceptorT::Config >
 Socket (const std::string &name)
 
 Socket (const std::shared_ptr< Config > &config)
 
 Socket (Socket &&) noexcept=delete
 
Socketoperator= (Socket &&) noexcept=delete
 
virtual ~Socket ()
 
ConfiggetConfig () const
 

Private Types

using SocketAcceptor = SocketAcceptorT
 
using SocketContextFactory = SocketContextFactoryT
 
using Super = core::socket::Socket< typename SocketAcceptor::Config >
 

Private Member Functions

 SocketServer (const std::shared_ptr< Config > &config, const std::shared_ptr< SocketContextFactory > &socketContextFactory, const std::function< void(SocketConnection *)> &onConnect, const std::function< void(SocketConnection *)> &onConnected, const std::function< void(SocketConnection *)> &onDisconnect)
 
void realListen (const std::function< void(const SocketAddress &, core::socket::State)> &onStatus, unsigned int tries, double retryTimeoutScale) const
 

Private Attributes

std::shared_ptr< SocketContextFactorysocketContextFactory
 
std::function< void(SocketConnection *)> onConnect
 
std::function< void(SocketConnection *)> onConnected
 
std::function< void(SocketConnection *)> onDisconnect
 

Additional Inherited Members

- Protected Member Functions inherited from core::socket::Socket< SocketAcceptorT::Config >
 Socket (const Socket &)=default
 
Socketoperator= (const Socket &)=default
 
- Protected Attributes inherited from core::socket::Socket< SocketAcceptorT::Config >
std::shared_ptr< Configconfig
 

Detailed Description

template<typename SocketAcceptorT, typename SocketContextFactoryT, typename... Args>
requires std::is_base_of_v<core::eventreceiver::AcceptEventReceiver, SocketAcceptorT> && std::is_base_of_v<core::socket::stream::SocketContextFactory, SocketContextFactoryT>
class core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >

Definition at line 68 of file SocketServer.h.

Member Typedef Documentation

◆ Config

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
using core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::Config = typename SocketAcceptor::Config

Definition at line 78 of file SocketServer.h.

◆ SocketAcceptor

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
using core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketAcceptor = SocketAcceptorT
private

Definition at line 70 of file SocketServer.h.

◆ SocketAddress

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
using core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketAddress = typename SocketAcceptor::SocketAddress

Definition at line 77 of file SocketServer.h.

◆ SocketConnection

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
using core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketConnection = typename SocketAcceptor::SocketConnection

Definition at line 76 of file SocketServer.h.

◆ SocketContextFactory

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
using core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketContextFactory = SocketContextFactoryT
private

Definition at line 71 of file SocketServer.h.

◆ Super

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
using core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::Super = core::socket::Socket<typename SocketAcceptor::Config>
private

Definition at line 73 of file SocketServer.h.

Constructor & Destructor Documentation

◆ SocketServer() [1/5]

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketServer ( const std::shared_ptr< Config > &  config,
const std::shared_ptr< SocketContextFactory > &  socketContextFactory,
const std::function< void(SocketConnection *)> &  onConnect,
const std::function< void(SocketConnection *)> &  onConnected,
const std::function< void(SocketConnection *)> &  onDisconnect 
)
inlineprivate

◆ SocketServer() [2/5]

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::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 
)
inline

Definition at line 94 of file SocketServer.h.

99 : Super(name)
100 , socketContextFactory(std::make_shared<SocketContextFactory>(std::forward<Args>(args)...))
101 , onConnect([onConnect](SocketConnection* socketConnection) { // onConnect
102 LOG(DEBUG) << socketConnection->getConnectionName() << ": OnConnect";
103
104 LOG(DEBUG) << " Local: " << socketConnection->getLocalAddress().toString();
105 LOG(DEBUG) << " Peer: " << socketConnection->getRemoteAddress().toString();
106
107 if (onConnect) {
108 onConnect(socketConnection);
109 }
110 })
111 , onConnected([onConnected](SocketConnection* socketConnection) { // onConnected
112 LOG(DEBUG) << socketConnection->getConnectionName() << ": OnConnected";
113
114 LOG(DEBUG) << " Local: " << socketConnection->getLocalAddress().toString();
115 LOG(DEBUG) << " Peer: " << socketConnection->getRemoteAddress().toString();
116
117 if (onConnected) {
118 onConnected(socketConnection);
119 }
120 })
121 , onDisconnect([onDisconnect](SocketConnection* socketConnection) { // onDisconnect
122 LOG(DEBUG) << socketConnection->getConnectionName() << ": OnDisconnect";
123
124 LOG(DEBUG) << " Local: " << socketConnection->getLocalAddress().toString();
125 LOG(DEBUG) << " Peer: " << socketConnection->getRemoteAddress().toString();
126
127 LOG(DEBUG) << " Online Since: " << socketConnection->getOnlineSince();
128 LOG(DEBUG) << " Online Duration: " << socketConnection->getOnlineDuration();
129
130 LOG(DEBUG) << " Total Queued: " << socketConnection->getTotalQueued();
131 LOG(DEBUG) << " Total Sent: " << socketConnection->getTotalSent();
132 LOG(DEBUG) << " Write Delta: " << socketConnection->getTotalQueued() - socketConnection->getTotalSent();
133 LOG(DEBUG) << " Total Read: " << socketConnection->getTotalRead();
134 LOG(DEBUG) << " Total Processed: " << socketConnection->getTotalProcessed();
135 LOG(DEBUG) << " Read Delta: " << socketConnection->getTotalRead() - socketConnection->getTotalProcessed();
136
137 if (onDisconnect) {
138 onDisconnect(socketConnection);
139 }
140 }) {
141 }
typename SocketAcceptor::SocketConnection SocketConnection

References core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onConnect, and core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::socketContextFactory.

◆ SocketServer() [3/5]

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketServer ( const std::function< void(SocketConnection *)> &  onConnect,
const std::function< void(SocketConnection *)> &  onConnected,
const std::function< void(SocketConnection *)> &  onDisconnect,
Args &&...  args 
)
inline

Definition at line 143 of file SocketServer.h.

147 : SocketServer("", onConnect, onConnected, onDisconnect, std::forward<Args>(args)...) {
148 }
SocketServer(const std::shared_ptr< Config > &config, const std::shared_ptr< SocketContextFactory > &socketContextFactory, const std::function< void(SocketConnection *)> &onConnect, const std::function< void(SocketConnection *)> &onConnected, const std::function< void(SocketConnection *)> &onDisconnect)

◆ SocketServer() [4/5]

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketServer ( const std::string &  name,
Args &&...  args 
)
inline

Definition at line 151 of file SocketServer.h.

152 : SocketServer(name, {}, {}, {}, std::forward<Args>(args)...) {
153 }

◆ SocketServer() [5/5]

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::SocketServer ( Args &&...  args)
inlineexplicit

Definition at line 155 of file SocketServer.h.

156 : SocketServer("", std::forward<Args>(args)...) {
157 }

Member Function Documentation

◆ getOnConnect()

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
std::function< void(SocketConnection *)> & core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::getOnConnect ( )
inline

◆ getOnConnected()

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
std::function< void(SocketConnection *)> & core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::getOnConnected ( )
inline

◆ getOnDisconnect()

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
std::function< void(SocketConnection *)> & core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::getOnDisconnect ( )
inline

◆ getSocketContextFactory()

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
std::shared_ptr< SocketContextFactory > core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::getSocketContextFactory ( )
inline

◆ listen() [1/3]

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
void core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::listen ( const SocketAddress localAddress,
const std::function< void(const SocketAddress &, core::socket::State)> &  onStatus 
) const
inline

Definition at line 222 of file SocketServer.h.

223 {
224 Super::config->Local::setSocketAddress(localAddress);
225
226 listen(onStatus);
227 }
void listen(const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const

◆ listen() [2/3]

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
void core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::listen ( const SocketAddress localAddress,
int  backlog,
const std::function< void(const SocketAddress &, core::socket::State)> &  onStatus 
) const
inline

Definition at line 229 of file SocketServer.h.

231 {
232 Super::config->Local::setBacklog(backlog);
233
234 listen(localAddress, onStatus);
235 }

◆ listen() [3/3]

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
void core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::listen ( const std::function< void(const SocketAddress &, core::socket::State)> &  onStatus) const
inline

Definition at line 218 of file SocketServer.h.

218 {
219 realListen(onStatus, 0, 1);
220 }
void realListen(const std::function< void(const SocketAddress &, core::socket::State)> &onStatus, unsigned int tries, double retryTimeoutScale) const

References core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::realListen().

Referenced by main(), express::legacy::in::Server(), express::legacy::in6::Server(), express::legacy::rc::Server(), express::legacy::un::Server(), express::tls::in::Server(), express::tls::in6::Server(), express::tls::rc::Server(), and express::tls::un::Server().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ realListen()

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
void core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::realListen ( const std::function< void(const SocketAddress &, core::socket::State)> &  onStatus,
unsigned int  tries,
double  retryTimeoutScale 
) const
inlineprivate

Definition at line 160 of file SocketServer.h.

162 {
164 new SocketAcceptor(
166 onConnect,
169 [config = this->config,
170 onConnect = this->onConnect,
171 onConnected = this->onConnected,
174 onStatus,
175 tries,
176 retryTimeoutScale](const SocketAddress& socketAddress, core::socket::State state) mutable {
177 const bool retryFlag = (state & core::socket::State::NO_RETRY) == 0;
179 onStatus(socketAddress, state);
180
181 if (retryFlag && config->getRetry() // Shall we potentially retry? In case are the ...
182 && (config->getRetryTries() == 0 || tries < config->getRetryTries()) // ... limits not reached and has an ...
183 && (state == core::socket::State::ERROR ||
184 (state == core::socket::State::FATAL && config->getRetryOnFatal()))) { // error occurred?
185 double relativeRetryTimeout =
186 config->getRetryLimit() > 0
187 ? std::min<double>(config->getRetryTimeout() * retryTimeoutScale, config->getRetryLimit())
188 : config->getRetryTimeout() * retryTimeoutScale;
189 relativeRetryTimeout -= utils::Random::getInRange(-config->getRetryJitter(), config->getRetryJitter()) *
190 relativeRetryTimeout / 100.;
191
192 LOG(INFO) << config->getInstanceName() << ": Retry listen in " << relativeRetryTimeout << " seconds";
193
195 [config,
196 onConnect,
199 onStatus,
200 tries,
201 retryTimeoutScale,
202 socketContextFactory]() mutable {
203 if (config->getRetry()) {
204 SocketServer(config, socketContextFactory, onConnect, onConnected, onDisconnect)
205 .realListen(onStatus, tries + 1, retryTimeoutScale * config->getRetryBase());
206 } else {
207 LOG(INFO) << config->getInstanceName() << ": Retry listen disabled during wait";
208 }
209 },
210 relativeRetryTimeout);
211 }
212 },
214 }
215 }
static State state()
Definition SNodeC.cpp:76
static constexpr int ERROR
Definition State.h:57
static constexpr int FATAL
Definition State.h:58
static constexpr int NO_RETRY
Definition State.h:59
typename SocketAcceptor::SocketAddress SocketAddress
static Timer singleshotTimer(const std::function< void()> &dispatcher, const utils::Timeval &timeout)
Definition Timer.cpp:57
static double getInRange(double ll, double ul)
Definition Random.cpp:52
Definition Timer.h:59

References core::socket::State::ERROR, core::socket::State::FATAL, utils::Random::getInRange(), core::INITIALIZED, core::socket::State::NO_RETRY, core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onConnect, core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onConnected, core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onDisconnect, core::socket::State::operator&(), core::socket::State::operator&=(), core::socket::State::operator==(), core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::realListen(), core::RUNNING, core::timer::Timer::singleshotTimer(), core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::socketContextFactory, and core::SNodeC::state().

Referenced by core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::listen(), and core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::realListen().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setOnConnect()

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
std::function< void(SocketConnection *)> core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::setOnConnect ( const std::function< void(SocketConnection *)> &  onConnect,
bool  initialize = false 
)
inline

Definition at line 241 of file SocketServer.h.

242 {
243 std::function<void(SocketConnection*)> oldOnConnect = this->onConnect;
244
245 this->onConnect = initialize ? onConnect : [oldOnConnect, onConnect](SocketConnection* socketConnection) {
246 oldOnConnect(socketConnection);
247 onConnect(socketConnection);
248 };
249
250 return oldOnConnect;
251 }

References core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onConnect.

◆ setOnConnected()

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
std::function< void(SocketConnection *)> core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::setOnConnected ( const std::function< void(SocketConnection *)> &  onConnected,
bool  initialize = false 
)
inline

Definition at line 257 of file SocketServer.h.

258 {
259 std::function<void(SocketConnection*)> oldOnConnected = this->onConnected;
260
261 this->onConnected = initialize ? onConnected : [oldOnConnected, onConnected](SocketConnection* socketConnection) {
262 oldOnConnected(socketConnection);
263 onConnected(socketConnection);
264 };
265
266 return oldOnConnected;
267 }

References core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onConnected.

◆ setOnDisconnect()

template<typename SocketAcceptorT , typename SocketContextFactoryT , typename... Args>
std::function< void(SocketConnection *)> core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::setOnDisconnect ( const std::function< void(SocketConnection *)> &  onDisconnect,
bool  initialize = false 
)
inline

Definition at line 273 of file SocketServer.h.

274 {
275 std::function<void(SocketConnection*)> oldOnDisconnect = this->onDisconnect;
276
277 this->onDisconnect = initialize ? onDisconnect : [oldOnDisconnect, onDisconnect](SocketConnection* socketConnection) {
278 oldOnDisconnect(socketConnection);
279 onDisconnect(socketConnection);
280 };
281
282 return oldOnDisconnect;
283 }

References core::socket::stream::SocketServer< SocketAcceptorT, SocketContextFactoryT, Args >::onDisconnect.

Member Data Documentation

◆ onConnect

◆ onConnected

◆ onDisconnect

◆ socketContextFactory


The documentation for this class was generated from the following file: