#include <ClientFlowController.h>

Inheritance diagram for core::socket::stream::ClientFlowController:

Collaboration diagram for core::socket::stream::ClientFlowController:

Public Member Functions
	ClientFlowController (net::config::ConfigInstance *configInstance)
void	stopReconnect ()
bool	isReconnectEnabled () const
ClientFlowController *	setOnFlowReconnect (const std::function< void(ClientFlowController *)> &callback)
Public Member Functions inherited from core::socket::stream::FlowController< ClientFlowController >
	FlowController (net::config::ConfigInstance *configInstance)
FlowController &	operator= (const FlowController &)=delete
virtual	~FlowController ()
std::string	getInstanceName () const
uint64_t	getId () const
bool	terminateFlow ()
bool	isTerminated () const
void	stopRetry ()
bool	isRetryEnabled () const
ClientFlowController *	setOnFlowRetry (const std::function< void(ClientFlowController *)> &callback)
ClientFlowController *	setOnFlowCompleted (const std::function< void(uint64_t, const std::string &)> &callback)
ClientFlowController *	setOnFlowTerminated (const std::function< void(ClientFlowController *)> &callback)
void	startFlow (const std::function< void()> &callback)

Private Member Functions
void	reportFlowReconnect ()
void	observeConnectEventReceiver (core::eventreceiver::ConnectEventReceiver *connectEventReceiver)
void	armReconnectTimer (double timeoutSeconds, const std::function< void()> &dispatcher)
void	terminateAsyncSubFlow () override
void	cancelReconnectTimer ()

Private Attributes
bool	reconnectEnabled {true}
std::set< core::eventreceiver::ConnectEventReceiver * >	connectEventReceivers
std::unique_ptr< core::timer::Timer >	reconnectTimer
std::function< void(ClientFlowController *)>	onFlowReconnectCallback

Friends
template<typename SocketConnectorT, typename SocketContextFactoryT, typename... Args>
class	SocketClient

Additional Inherited Members
Protected Member Functions inherited from core::socket::stream::FlowController< ClientFlowController >
void	reportFlowRetry ()
void	armRetryTimer (double timeoutSeconds, const std::function< void()> &dispatcher)

Detailed Description

Definition at line 70 of file ClientFlowController.h.

Constructor & Destructor Documentation

◆ ClientFlowController()

core::socket::stream::ClientFlowController::ClientFlowController ( net::config::ConfigInstance * configInstance )

Definition at line 19 of file ClientFlowController.cpp.

        : FlowController(configInstance)
        , onFlowReconnectCallback([](ClientFlowController*) {
        }) {
    }

References core::socket::stream::FlowController< ConcreteFlowController >::FlowController(), and onFlowReconnectCallback.

Here is the call graph for this function:

Member Function Documentation

◆ armReconnectTimer()

void core::socket::stream::ClientFlowController::armReconnectTimer	(	double	timeoutSeconds,
		const std::function< void()> &	dispatcher )

private

Definition at line 58 of file ClientFlowController.cpp.

                                                                                                             {
        if (reconnectEnabled) {
            reconnectTimer = std::make_unique<core::timer::Timer>(core::timer::Timer::singleshotTimer(dispatcher, timeoutSeconds));
        }
    }

References reconnectEnabled, reconnectTimer, and core::timer::Timer::singleshotTimer().

Here is the call graph for this function:

◆ cancelReconnectTimer()

void core::socket::stream::ClientFlowController::cancelReconnectTimer ( )

private

Definition at line 77 of file ClientFlowController.cpp.

                                                    {
        if (reconnectTimer) {
            reconnectTimer->cancel();
            reconnectTimer.reset();
        }
    }

References core::Timer::cancel(), and reconnectTimer.

Referenced by stopReconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isReconnectEnabled()

bool core::socket::stream::ClientFlowController::isReconnectEnabled ( ) const

Definition at line 30 of file ClientFlowController.cpp.

                                                        {
        return reconnectEnabled;
    }

References reconnectEnabled.

◆ observeConnectEventReceiver()

void core::socket::stream::ClientFlowController::observeConnectEventReceiver ( core::eventreceiver::ConnectEventReceiver * connectEventReceiver )

private

Definition at line 48 of file ClientFlowController.cpp.

                                                                                                                      {
        if (connectEventReceiver != nullptr) {
            if (connectEventReceiver->isEnabled()) {
                connectEventReceivers.insert(connectEventReceiver);
            } else {
                connectEventReceivers.erase(connectEventReceiver);
            }
        }
    }

References connectEventReceivers, and core::DescriptorEventReceiver::isEnabled().

Here is the call graph for this function:

◆ reportFlowReconnect()

void core::socket::stream::ClientFlowController::reportFlowReconnect ( )

private

Definition at line 44 of file ClientFlowController.cpp.

                                                   {
        onFlowReconnectCallback(this);
    }

References onFlowReconnectCallback.

◆ setOnFlowReconnect()

ClientFlowController * core::socket::stream::ClientFlowController::setOnFlowReconnect ( const std::function< void(ClientFlowController *)> & callback )

Definition at line 34 of file ClientFlowController.cpp.

                                                                                                                           {
        const std::function<void(ClientFlowController*)> oldCallback = onFlowReconnectCallback;
        onFlowReconnectCallback = [oldCallback, callback](ClientFlowController* flowController) {
            oldCallback(flowController);
            callback(flowController);
        };
 
        return this;
    }

References onFlowReconnectCallback.

◆ stopReconnect()

void core::socket::stream::ClientFlowController::stopReconnect ( )

Definition at line 25 of file ClientFlowController.cpp.

                                             {
        reconnectEnabled = false;
        cancelReconnectTimer();
    }

References cancelReconnectTimer(), and reconnectEnabled.

Referenced by terminateAsyncSubFlow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ terminateAsyncSubFlow()

void core::socket::stream::ClientFlowController::terminateAsyncSubFlow ( )

overrideprivatevirtual

Implements core::socket::stream::FlowController< ClientFlowController >.

Definition at line 64 of file ClientFlowController.cpp.

                                                     {
        stopReconnect();
        stopRetry();
 
        for (core::eventreceiver::ConnectEventReceiver* connectEventReceiver : connectEventReceivers) {
            if (connectEventReceiver != nullptr) {
                connectEventReceiver->stopConnect();
            }
        }
 
        connectEventReceivers.clear();
    }

References connectEventReceivers, core::eventreceiver::ConnectEventReceiver::stopConnect(), stopReconnect(), and core::socket::stream::FlowController< ConcreteFlowController >::stopRetry().

Here is the call graph for this function:

◆ SocketClient

template<typename SocketConnectorT, typename SocketContextFactoryT, typename... Args>

friend class SocketClient

friend

Definition at line 101 of file ClientFlowController.h.

Member Data Documentation

◆ connectEventReceivers

std::set<core::eventreceiver::ConnectEventReceiver*> core::socket::stream::ClientFlowController::connectEventReceivers

private

Definition at line 92 of file ClientFlowController.h.

Referenced by observeConnectEventReceiver(), and terminateAsyncSubFlow().

◆ onFlowReconnectCallback

std::function<void(ClientFlowController*)> core::socket::stream::ClientFlowController::onFlowReconnectCallback

private

Definition at line 96 of file ClientFlowController.h.

Referenced by ClientFlowController(), reportFlowReconnect(), and setOnFlowReconnect().

◆ reconnectEnabled

bool core::socket::stream::ClientFlowController::reconnectEnabled {true}

private

Definition at line 90 of file ClientFlowController.h.

90{true};

Referenced by armReconnectTimer(), isReconnectEnabled(), and stopReconnect().

◆ reconnectTimer

std::unique_ptr<core::timer::Timer> core::socket::stream::ClientFlowController::reconnectTimer

private

Definition at line 94 of file ClientFlowController.h.

Referenced by armReconnectTimer(), and cancelReconnectTimer().

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

core/socket/stream/ClientFlowController.h
core/socket/stream/ClientFlowController.cpp

SNode.C

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ClientFlowController()

Member Function Documentation

◆ armReconnectTimer()

◆ cancelReconnectTimer()

◆ isReconnectEnabled()

◆ observeConnectEventReceiver()

◆ reportFlowReconnect()

◆ setOnFlowReconnect()

◆ stopReconnect()

◆ terminateAsyncSubFlow()

Friends And Related Symbol Documentation

◆ SocketClient

Member Data Documentation

◆ connectEventReceivers

◆ onFlowReconnectCallback

◆ reconnectEnabled

◆ reconnectTimer