#include <FlowController.h>

Collaboration diagram for core::socket::stream::FlowController< ConcreteFlowController >:

Public Member Functions
	FlowController (net::config::ConfigInstance *configInstance)
	FlowController (const FlowController &)=delete
FlowController &	operator= (const FlowController &)=delete
	FlowController (FlowController &&)=delete
FlowController &	operator= (FlowController &&)=delete
virtual	~FlowController ()
std::string	getInstanceName () const
uint64_t	getId () const
bool	terminateFlow ()
bool	isTerminated () const
void	stopRetry ()
bool	isRetryEnabled () const
ConcreteFlowController *	setOnFlowRetry (const std::function< void(ConcreteFlowController *)> &callback)
ConcreteFlowController *	setOnFlowCompleted (const std::function< void(uint64_t, const std::string &)> &callback)
ConcreteFlowController *	setOnFlowTerminated (const std::function< void(ConcreteFlowController *)> &callback)
void	startFlow (const std::function< void()> &callback)

Protected Member Functions
void	reportFlowRetry ()
void	armRetryTimer (double timeoutSeconds, const std::function< void()> &dispatcher)
virtual void	terminateAsyncSubFlow ()=0

Private Member Functions
void	cancelRetryTimer ()
void	notifyFlowTerminated ()

Private Attributes
uint64_t	id {idCounter++}
bool	retryEnabled {true}
bool	terminated {false}
net::config::ConfigInstance *	observedConfigInstance
std::unique_ptr< core::timer::Timer >	retryTimer
std::function< void(ConcreteFlowController *)>	onFlowRetryCallback
std::function< void(ConcreteFlowController *)>	onFlowTerminatedCallback

Static Private Attributes
static uint64_t	idCounter

Detailed Description

template<typename ConcreteFlowController>
class core::socket::stream::FlowController< ConcreteFlowController >

Definition at line 65 of file FlowController.h.

Constructor & Destructor Documentation

◆ FlowController() [1/3]

template<typename ConcreteFlowController>

core::socket::stream::FlowController< ConcreteFlowController >::FlowController ( net::config::ConfigInstance * configInstance )

Definition at line 57 of file FlowController.hpp.

        : observedConfigInstance(configInstance)
        , onFlowRetryCallback([](FlowController*) {
        })
        , onFlowTerminatedCallback([](FlowController*) {
        }) {
    }

References observedConfigInstance, and onFlowRetryCallback.

Referenced by core::socket::stream::ClientFlowController::ClientFlowController(), and core::socket::stream::ServerFlowController::ServerFlowController().

Here is the caller graph for this function:

◆ FlowController() [2/3]

template<typename ConcreteFlowController>

core::socket::stream::FlowController< ConcreteFlowController >::FlowController ( const FlowController< ConcreteFlowController > & )

delete

◆ FlowController() [3/3]

template<typename ConcreteFlowController>

core::socket::stream::FlowController< ConcreteFlowController >::FlowController ( FlowController< ConcreteFlowController > && )

delete

◆ ~FlowController()

template<typename ConcreteFlowController>

core::socket::stream::FlowController< ConcreteFlowController >::~FlowController ( )

virtualdefault

Member Function Documentation

◆ armRetryTimer()

template<typename ConcreteFlowController>

void core::socket::stream::FlowController< ConcreteFlowController >::armRetryTimer	(	double	timeoutSeconds,
		const std::function< void()> &	dispatcher )

protected

Definition at line 161 of file FlowController.hpp.

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

References retryEnabled, retryTimer, and core::timer::Timer::singleshotTimer().

Here is the call graph for this function:

◆ cancelRetryTimer()

template<typename ConcreteFlowController>

void core::socket::stream::FlowController< ConcreteFlowController >::cancelRetryTimer ( )

private

Definition at line 168 of file FlowController.hpp.

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

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

Here is the call graph for this function:

◆ getId()

template<typename ConcreteFlowController>

uint64_t core::socket::stream::FlowController< ConcreteFlowController >::getId ( ) const

Definition at line 74 of file FlowController.hpp.

                                                                 {
        return id;
    }

References id.

Referenced by setOnFlowCompleted().

Here is the caller graph for this function:

◆ getInstanceName()

template<typename ConcreteFlowController>

std::string core::socket::stream::FlowController< ConcreteFlowController >::getInstanceName ( ) const

Definition at line 69 of file FlowController.hpp.

                                                                            {
        return observedConfigInstance->getInstanceName();
    }

References net::config::ConfigInstance::getInstanceName(), and observedConfigInstance.

Here is the call graph for this function:

◆ isRetryEnabled()

template<typename ConcreteFlowController>

bool core::socket::stream::FlowController< ConcreteFlowController >::isRetryEnabled ( ) const

Definition at line 108 of file FlowController.hpp.

                                                                      {
        return retryEnabled;
    }

References retryEnabled.

◆ isTerminated()

template<typename ConcreteFlowController>

bool core::socket::stream::FlowController< ConcreteFlowController >::isTerminated ( ) const

Definition at line 97 of file FlowController.hpp.

                                                                    {
        return terminated;
    }

References terminated.

◆ notifyFlowTerminated()

template<typename ConcreteFlowController>

void core::socket::stream::FlowController< ConcreteFlowController >::notifyFlowTerminated ( )

private

Definition at line 176 of file FlowController.hpp.

                                                                      {
        onFlowTerminatedCallback(dynamic_cast<ConcreteFlowController*>(this));
    }

References onFlowTerminatedCallback.

◆ operator=() [1/2]

template<typename ConcreteFlowController>

FlowController & core::socket::stream::FlowController< ConcreteFlowController >::operator= ( const FlowController< ConcreteFlowController > & )

delete

◆ operator=() [2/2]

template<typename ConcreteFlowController>

FlowController & core::socket::stream::FlowController< ConcreteFlowController >::operator= ( FlowController< ConcreteFlowController > && )

delete

◆ reportFlowRetry()

template<typename ConcreteFlowController>

void core::socket::stream::FlowController< ConcreteFlowController >::reportFlowRetry ( )

protected

Definition at line 156 of file FlowController.hpp.

                                                                 {
        onFlowRetryCallback(dynamic_cast<ConcreteFlowController*>(this));
    }

References onFlowRetryCallback.

◆ setOnFlowCompleted()

template<typename ConcreteFlowController>

ConcreteFlowController * core::socket::stream::FlowController< ConcreteFlowController >::setOnFlowCompleted ( const std::function< void(uint64_t, const std::string &)> & callback )

Definition at line 126 of file FlowController.hpp.

                                                                                                                            {
        observedConfigInstance->setOnDestroy([callback, id = getId()](net::config::ConfigInstance* configInstance) {
            callback(id, configInstance->getInstanceName());
        });
 
        return dynamic_cast<ConcreteFlowController*>(this);
    }

References getId(), net::config::ConfigInstance::getInstanceName(), observedConfigInstance, and net::config::ConfigInstance::setOnDestroy().

Here is the call graph for this function:

◆ setOnFlowRetry()

template<typename ConcreteFlowController>

ConcreteFlowController * core::socket::stream::FlowController< ConcreteFlowController >::setOnFlowRetry ( const std::function< void(ConcreteFlowController< ConcreteFlowController > *)> & callback )

Definition at line 114 of file FlowController.hpp.

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

References onFlowRetryCallback.

◆ setOnFlowTerminated()

template<typename ConcreteFlowController>

ConcreteFlowController * core::socket::stream::FlowController< ConcreteFlowController >::setOnFlowTerminated ( const std::function< void(ConcreteFlowController< ConcreteFlowController > *)> & callback )

Definition at line 136 of file FlowController.hpp.

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

References onFlowTerminatedCallback.

◆ startFlow()

template<typename ConcreteFlowController>

void core::socket::stream::FlowController< ConcreteFlowController >::startFlow ( const std::function< void()> & callback )

Definition at line 147 of file FlowController.hpp.

                                                                                              {
        core::EventReceiver::atNextTick([this, callback] {
            if (!terminated) {
                callback();
            }
        });
    }

References core::EventReceiver::atNextTick(), and terminated.

Here is the call graph for this function:

◆ stopRetry()

template<typename ConcreteFlowController>

void core::socket::stream::FlowController< ConcreteFlowController >::stopRetry ( )

Definition at line 102 of file FlowController.hpp.

                                                           {
        retryEnabled = false;
        cancelRetryTimer();
    }

Referenced by core::socket::stream::ClientFlowController::terminateAsyncSubFlow(), and core::socket::stream::ServerFlowController::terminateAsyncSubFlow().

Here is the caller graph for this function:

◆ terminateAsyncSubFlow()

template<typename ConcreteFlowController>

virtual void core::socket::stream::FlowController< ConcreteFlowController >::terminateAsyncSubFlow ( )

protectedpure virtual

Implemented in core::socket::stream::ClientFlowController, and core::socket::stream::ServerFlowController.

◆ terminateFlow()

template<typename ConcreteFlowController>

bool core::socket::stream::FlowController< ConcreteFlowController >::terminateFlow ( )

Definition at line 79 of file FlowController.hpp.

                                                               {
        bool success = false;
 
        if (!terminated) {
            terminated = true;
            retryEnabled = false;
            cancelRetryTimer();
 
            terminateAsyncSubFlow();
            notifyFlowTerminated();
 
            success = true;
        }
 
        return success;
    }

Member Data Documentation

◆ id

template<typename ConcreteFlowController>

uint64_t core::socket::stream::FlowController< ConcreteFlowController >::id {idCounter++}

private

Definition at line 101 of file FlowController.h.

101{idCounter++};

core::socket::stream::FlowController::idCounter

static uint64_t idCounter

Definition FlowController.h:102

Referenced by getId().

◆ idCounter

template<typename ConcreteFlowController>

uint64_t core::socket::stream::FlowController< ConcreteFlowController >::idCounter

staticprivate

Definition at line 102 of file FlowController.h.

◆ observedConfigInstance

template<typename ConcreteFlowController>

net::config::ConfigInstance* core::socket::stream::FlowController< ConcreteFlowController >::observedConfigInstance

private

Definition at line 109 of file FlowController.h.

Referenced by FlowController(), getInstanceName(), and setOnFlowCompleted().

◆ onFlowRetryCallback

template<typename ConcreteFlowController>

std::function<void(ConcreteFlowController*)> core::socket::stream::FlowController< ConcreteFlowController >::onFlowRetryCallback

private

Definition at line 113 of file FlowController.h.

Referenced by FlowController(), reportFlowRetry(), and setOnFlowRetry().

◆ onFlowTerminatedCallback

template<typename ConcreteFlowController>

std::function<void(ConcreteFlowController*)> core::socket::stream::FlowController< ConcreteFlowController >::onFlowTerminatedCallback

private

Definition at line 114 of file FlowController.h.

Referenced by notifyFlowTerminated(), and setOnFlowTerminated().

◆ retryEnabled

template<typename ConcreteFlowController>

bool core::socket::stream::FlowController< ConcreteFlowController >::retryEnabled {true}

private

Definition at line 106 of file FlowController.h.

106{true};

Referenced by armRetryTimer(), and isRetryEnabled().

◆ retryTimer

template<typename ConcreteFlowController>

std::unique_ptr<core::timer::Timer> core::socket::stream::FlowController< ConcreteFlowController >::retryTimer

private

Definition at line 111 of file FlowController.h.

Referenced by armRetryTimer(), and cancelRetryTimer().

◆ terminated

template<typename ConcreteFlowController>

bool core::socket::stream::FlowController< ConcreteFlowController >::terminated {false}

private

Definition at line 107 of file FlowController.h.

107{false};

Referenced by isTerminated(), core::socket::stream::FlowController< ClientFlowController >::isTerminated(), and startFlow().

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

core/socket/stream/FlowController.h
core/socket/stream/FlowController.hpp

SNode.C

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FlowController() [1/3]

◆ FlowController() [2/3]

◆ FlowController() [3/3]

◆ ~FlowController()

Member Function Documentation

◆ armRetryTimer()

◆ cancelRetryTimer()

◆ getId()

◆ getInstanceName()

◆ isRetryEnabled()

◆ isTerminated()

◆ notifyFlowTerminated()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ reportFlowRetry()

◆ setOnFlowCompleted()

◆ setOnFlowRetry()

◆ setOnFlowTerminated()

◆ startFlow()

◆ stopRetry()

◆ terminateAsyncSubFlow()

◆ terminateFlow()

Member Data Documentation

◆ id

◆ idCounter

◆ observedConfigInstance

◆ onFlowRetryCallback

◆ onFlowTerminatedCallback

◆ retryEnabled

◆ retryTimer

◆ terminated