Inheritance diagram for TestBaseDaemon:

Collaboration diagram for TestBaseDaemon:

Public Member Functions
template<typename _Callable>
bool	addCallableMethod (_Callable &&function, const PString &name)
	Add a callable method of the Daemon.

virtual void	addCallMethod ()
	Do the addCallableMethod here.

template<typename _Class, typename _Data>
bool	addDataCallableMethod (PUncastableBool(&function)(_Class &, const _Data &), _Class &persistentData, size_t nbBin, float histLowerBound, float histUpperBound)
	Add a callable method of the Daemon.

template<typename _Data>
bool	addDataCallableMethod (PUncastableBool(&function)(const _Data &), size_t nbBin, float histLowerBound, float histUpperBound)
	Add a callable method of the Daemon.

void	addMessageToConfirm (const Swarm::Message &message)
	Add a message to confirm.

bool	callMethod (Swarm::Data &result, const PString &name, const Swarm::Data &parameter)
	Call an added callable method by name.

void	checkMessageTimeout (time_t currentTime)
	Check if a message has reached the timeout.

void	clearCallableMethod ()
	Clear the map of callable methods.

void	clearStat ()
	Clear all the statistics of the daemon.

StatAccumulator	createNewStat (size_t nbBin, float histLowerBound, float histUpperBound)
	Create a new clear computing statistic.

virtual bool	extraLoad (const ConfigNode *config)
	Extra call on load for the current Daemon.

void	fillDaemonStat (Swarm::Stat &stat, time_t startTimestamp, time_t endTimestamp)
	Fill the Stat with the current statistics of the daemon.

VecStat	fillVecStat (const Swarm::StatAccumulator &accumulator, time_t startTimestamp, time_t endTimestamp)
	Fill a VecStat from a StatAccumulator to send to the DamonStat.

DaemonConfig &	getConfig ()
	Get the configuration of the current BaseDaemon.

Swarm::AbstractDataFunction *	getDataFunction (const Swarm::Data &data)
	Get the data function associated with the given data.

PLog &	getLog ()
	Get the log of the current BaseDaemon.

PLog &	getLogger ()
	Get the logger of the current BaseDaemon.

DaemonMainConfig &	getMainConfig ()
	Get the main configuration of the swarm.

MapDaemonConfig &	getMapDaemonConfig ()
	Get the map of all Daemon configurations.

const std::map< size_t, Swarm::Message > &	getMapMessageToBeConfirmed () const
	Get the map of message to be confirmed.

size_t	getMessageId ()
	Get current message id.

bool	getMessageToConfirm (Swarm::Message &message, size_t id) const
	Get a message to confirm by id if it exists.

OptionParser &	getOptionParser ()
	Return the OptionParser of the current BaseDaemon.

bool	isDaemonExist (const PString &name) const
	Say if a neighbour Daemon does exist.

bool	load (const PPath &fileName, const PString &daemonName)
	Load the Toml configuration which define all BaseDaemons of the Swarm.

bool	load (const PString &configFileContent, const PString &daemonName, ConfigFormat::ConfigFormat format)
	Load the Json configuration which define all BaseDaemons of the Swarm.

void	loadConfigFromNode (const ConfigNode &dico, const PString &daemonName)
	Load configuration form a node of ConfigNode.

bool	parseArgument (int argc, char **argv)
	Parse arguments given to the BaseDaemon with command line.

void	processConfirmedMessage (size_t id, time_t currentTime)
	Process confirmed message.

bool	processData (const Swarm::Data &data)
	Process given data with the proper method.

void	stop ()
	Stops the BaseDaemon.

void	updateStatAccumulator (StatAccumulator &stat, float value)
	Update a computing statistic with a new value.

Protected Attributes
DaemonConfig	p_config
	Configuration of the curent Daemon.

bool	p_isFullMock
	True if the daemon has to be executed in mock mode for socket and clock.

bool	p_isFullMockRecord
	True if the daemon has to be executed in mock record mode for socket and clock.

bool	p_isRun
	True if the current BaseDaemon is running.

PLog	p_log
	Logger of the current Daemon.

DaemonMainConfig	p_mainConfig
	Main configuration of the Daemon.

MapDaemonConfig	p_mapDaemon
	Map of the other Daemon of the Swarm.

Private Member Functions
std::map< PString, StatAccumulator >	createNewCommunicationStatMap (const PString &dataType, size_t nbBin, float histLowerBound, float histUpperBound)
	Create a new map of communication statistic.

void	getCommunicationStat (const PString &destName, const PString &dataType, float latency, size_t nbBin, float histLowerBound, float histUpperBound)
	Add a communication statistic.

void	initialisationBaseDaemon ()
	Initialisation function of the class BaseDaemon.

Private Attributes
std::map< PString, Swarm::AbstractFunction * >	p_mapCallableMethod
	Map of callable method of the Daemon.

std::map< PString, Swarm::AbstractDataFunction * >	p_mapDataFunction
	Map of methods which have to be called when receiving data.

std::map< size_t, Swarm::Message >	p_mapMessageToBeConfirmed
	Map of messages which have to be confirmed by destination Daemon.

size_t	p_messageId
	Id counter of the message of the current Daemon.

OptionParser	p_optionParser
	Option parser of the Daemon.

Detailed Description

Test Daemon.

Definition at line 321 of file main.cpp.

Member Function Documentation

◆ addCallableMethod()

template<typename _Callable>

bool Swarm::BaseDaemon::addCallableMethod	(	_Callable &&	function,
		const PString &	name )

inlineinherited

Add a callable method of the Daemon.

Parameters

function	: method to be added
name	: name of the method which can be called

Returns: true on success, false otherwise

Definition at line 73 of file BaseDaemon.h.

                                                                                   {
                        std::map<PString, AbstractFunction*>::iterator it(p_mapCallableMethod.find(name));
                        if(it != p_mapCallableMethod.end()){
                                getLog().getLogError() << "BaseDaemon::addCallableMethod : function '"<<name<<"' already added" << std::endl;
                                return false;
                        }
                        p_mapCallableMethod[name] = new FunctionCall(function, name);
                        return true;
                }

References getLog(), and p_mapCallableMethod.

Here is the call graph for this function:

◆ addCallMethod()

void BaseDaemon::addCallMethod ( )

virtualinherited

Do the addCallableMethod here.

Reimplemented in Swarm::Monitoring< _TBackend >.

Definition at line 113 of file BaseDaemon.cpp.

                              {
        if(p_log.isOpen()){
                p_log.getLogWarning() << "BaseDaemon::addCallMethod : no redefined addCallMethod " << std::endl;
        }else{
                std::cerr << "BaseDaemon::addCallMethod : no redefined addCallMethod (and no log file so we use std::cerr)" << std::endl;
        }
}

References p_log.

Referenced by loadConfigFromNode().

Here is the caller graph for this function:

◆ addDataCallableMethod() [1/2]

template<typename _Class, typename _Data>

bool Swarm::BaseDaemon::addDataCallableMethod	(	PUncastableBool(&)(_Class &, const _Data &)	function,
		_Class &	persistentData,
		size_t	nbBin,
		float	histLowerBound,
		float	histUpperBound )

inlineinherited

Add a callable method of the Daemon.

Parameters

function	: method to be added
persistentData	: data used each time the method is called
nbBin	: number of bin in the histogram
histLowerBound	: lower bound of the histogram
histUpperBound	: upper bound of the histogram

Returns: true on success, false otherwise

Definition at line 128 of file BaseDaemon.h.

                                                                                                                                                                                  {
                        PString prototype(phoenix_getTypeToStr<_Data>());
                        std::cout << "BaseDaemon::addDataCallableMethod : prototype = " << prototype << std::endl;
                        std::map<PString, Swarm::AbstractDataFunction*>::iterator it(p_mapDataFunction.find(prototype));
                        if(it != p_mapDataFunction.end()){
                                getLog().getLogError() << "BaseDaemon::addDataCallableMethod : function to process data '"<<prototype<<"' already added" << std::endl;
                                return false;
                        }
                        getLog().getLogDebug() << "BaseDaemon::addDataCallableMethod : add method to process data '"<<prototype<<"'" << std::endl;
                        p_mapDataFunction[prototype] = new Swarm::DataFunctionClassCall(function, persistentData, prototype);
                        p_config.getDaemonStatAccumulator().getMapStatComputing()[prototype] = createNewStat(nbBin, histLowerBound, histUpperBound);
                        return true;
                }

References createNewStat(), getLog(), p_config, and p_mapDataFunction.

Here is the call graph for this function:

◆ addDataCallableMethod() [2/2]

template<typename _Data>

bool Swarm::BaseDaemon::addDataCallableMethod	(	PUncastableBool(&)(const _Data &)	function,
		size_t	nbBin,
		float	histLowerBound,
		float	histUpperBound )

inlineinherited

Add a callable method of the Daemon.

Parameters

function	: method to be added
nbBin	: number of bin in the histogram
histLowerBound	: lower bound of the histogram
histUpperBound	: upper bound of the histogram

Returns: true on success, false otherwise

Definition at line 105 of file BaseDaemon.h.

                                                                                                                                               {
                        PString prototype(phoenix_getTypeToStr<_Data>());
                        std::cout << "BaseDaemon::addDataCallableMethod : prototype = " << prototype << std::endl;
                        std::map<PString, Swarm::AbstractDataFunction*>::iterator it(p_mapDataFunction.find(prototype));
                        if(it != p_mapDataFunction.end()){
                                getLog().getLogError() << "BaseDaemon::addDataCallableMethod : function to process data '"<<prototype<<"' already added" << std::endl;
                                return false;
                        }
                        getLog().getLogDebug() << "BaseDaemon::addDataCallableMethod : add method to process data '"<<prototype<<"'" << std::endl;
                        p_mapDataFunction[prototype] = new Swarm::DataFunctionCall(function, prototype);
                        p_config.getDaemonStatAccumulator().getMapStatComputing()[prototype] = createNewStat(nbBin, histLowerBound, histUpperBound);
                        return true;
                }

References createNewStat(), getLog(), p_config, and p_mapDataFunction.

Referenced by Swarm::Monitoring< _TBackend >::addCallMethod().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addMessageToConfirm()

void BaseDaemon::addMessageToConfirm ( const Swarm::Message & message )

inherited

Add a message to confirm.

Parameters

message : message to be added

Definition at line 186 of file BaseDaemon.cpp.

                                                           {
        p_mapMessageToBeConfirmed[message.getId()] = message;
}

References Swarm::Message::getId(), and p_mapMessageToBeConfirmed.

Referenced by Swarm::Daemon< _TBackend >::sendMessage(), testBaseDaemonGetMessageToConfirm(), and testBaseDaemonProcessConfirmedMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ callMethod()

bool BaseDaemon::callMethod	(	Swarm::Data &	result,
		const PString &	name,
		const Swarm::Data &	parameter )

inherited

Call an added callable method by name.

Parameters

[out]	result	: result of the call
	name	: name of the method
	parameter	: parameters of the call

Returns: true on success, false otherwise

Definition at line 127 of file BaseDaemon.cpp.

                                                                                      {
        std::map<PString, AbstractFunction*>::iterator it(p_mapCallableMethod.find(name));
        if(it == p_mapCallableMethod.end()){
                getLog().getLogError() << "BaseDaemon::callMethod : function '"<<name<<"' not found" << std::endl;
                return false;
        }
        return p_mapCallableMethod[name]->call(p_log, result, parameter);
}

References getLog(), p_log, and p_mapCallableMethod.

Here is the call graph for this function:

◆ checkMessageTimeout()

void BaseDaemon::checkMessageTimeout ( time_t currentTime )

inherited

Check if a message has reached the timeout.

Parameters

currentTime : current time

Definition at line 229 of file BaseDaemon.cpp.

                                                      {
        std::vector<size_t> messagesToRemove;
        for(auto it = p_mapMessageToBeConfirmed.begin(); it != p_mapMessageToBeConfirmed.end(); ++it){
                const size_t & messageId = it->first;
                const Message & message = it->second;
                time_t elapsedTime = currentTime - message.getSendTime();
                if(message.getVecRecver().size() == 0lu){
                        getLog().getLogError() << "BaseDaemon::checkMessageTimeout() : message " << messageId << " has no receiver." << std::endl;
                        continue;
                }
                std::map<PString, time_t>::const_iterator timeoutIt = p_config.getMapTimeout().find(message.getVecRecver().front());
                if(timeoutIt == p_config.getMapTimeout().end()){
                        getLog().getLogError() << "BaseDaemon::checkMessageTimeout() : no timeout found for receiver '" << message.getVecRecver().front() << "' of message " << messageId << "." << std::endl;
                        continue;
                }
                time_t timeout = timeoutIt->second;
                phoenix_assert(message.getVecRecver().size() != 0lu);
                if (elapsedTime > timeout) {
                        messagesToRemove.push_back(messageId);
                        getLog().getLogWarning() << "BaseDaemon::checkMessageTimeout() : Timeout Reached for message " << messageId << " sent to '" << message.getVecRecver().front() << "'. Removing unconfirmed transaction" << std::endl;
                }
        }
        for(const size_t & messageId : messagesToRemove){
                p_mapMessageToBeConfirmed.erase(messageId);
        }
}

References getLog(), Swarm::Message::getSendTime(), Swarm::Message::getVecRecver(), p_config, and p_mapMessageToBeConfirmed.

Referenced by Swarm::Daemon< _TBackend >::run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearCallableMethod()

void BaseDaemon::clearCallableMethod ( )

inherited

Clear the map of callable methods.

Definition at line 137 of file BaseDaemon.cpp.

                                    {
        for(std::map<PString, AbstractFunction*>::iterator it(p_mapCallableMethod.begin()); it != p_mapCallableMethod.end(); ++it){
                delete it->second;
        }
        p_mapCallableMethod.clear();
}

References p_mapCallableMethod.

Referenced by ~BaseDaemon().

Here is the caller graph for this function:

◆ clearStat()

void BaseDaemon::clearStat ( )

inherited

Clear all the statistics of the daemon.

Definition at line 355 of file BaseDaemon.cpp.

                          {
        for(MapStatAccumulator::iterator it = p_config.getDaemonStatAccumulator().getMapStatComputing().begin(); it != p_config.getDaemonStatAccumulator().getMapStatComputing().end(); ++it){
                it->second.setNbEvent(0lu);
                std::fill(it->second.getVecHistogram().begin(), it->second.getVecHistogram().end(), 0lu);
        }
        for(MapDaemonStatAccumulator::iterator itMap = p_config.getDaemonStatAccumulator().getMapStatCommunication().begin(); itMap != p_config.getDaemonStatAccumulator().getMapStatCommunication().end(); ++itMap){
                for(MapStatAccumulator::iterator it = itMap->second.begin(); it != itMap->second.end(); ++it){
                        it->second.setNbEvent(0lu);
                        std::fill(it->second.getVecHistogram().begin(), it->second.getVecHistogram().end(), 0lu);
                }
        }
}

References p_config.

Referenced by Swarm::Daemon< _TBackend >::sendStatToStatDaemon(), and testClearStatAccumulator().

Here is the caller graph for this function:

◆ createNewCommunicationStatMap()

std::map< PString, StatAccumulator > BaseDaemon::createNewCommunicationStatMap	(	const PString &	dataType,
		size_t	nbBin,
		float	histLowerBound,
		float	histUpperBound )

privateinherited

Create a new map of communication statistic.

Parameters

dataType	: type of data which where pushed
nbBin	: number of bin of the histogram
histLowerBound	: lower bound of the histogram
histUpperBound	: upper bound of the histogram

Returns: new map of communication statistic

Definition at line 417 of file BaseDaemon.cpp.

                                                                                                                                                            {
        std::map<PString, StatAccumulator> newStatMap;
        newStatMap[dataType] = createNewStat(nbBin, histLowerBound, histUpperBound);
        return newStatMap;
}

References createNewStat().

Referenced by getCommunicationStat().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createNewStat()

StatAccumulator BaseDaemon::createNewStat	(	size_t	nbBin,
		float	histLowerBound,
		float	histUpperBound )

inherited

Create a new clear computing statistic.

Parameters

nbBin	: number of bin of the histogram
histLowerBound	: lower bound of the histogram
histUpperBound	: upper bound of the histogram

Returns: new clear computing statistic

Definition at line 332 of file BaseDaemon.cpp.

                                                                                                 {
        StatAccumulator newStat;
        newStat.setNbEvent(0lu);
        newStat.setMin(std::nan(""));
        newStat.setMax(std::nan(""));
        newStat.setSum(std::nan(""));
        newStat.setNbEventAboveUpperBound(0lu);
        newStat.setNbEventBelowLowerBound(0lu);
        newStat.setHistUpperBound(histUpperBound);
        newStat.setHistLowerBound(histLowerBound);
        newStat.setVecHistogram(std::vector<size_t>(nbBin, 0lu));
        return newStat;
}

References Swarm::StatAccumulator::setHistLowerBound(), Swarm::StatAccumulator::setHistUpperBound(), Swarm::StatAccumulator::setMax(), Swarm::StatAccumulator::setMin(), Swarm::StatAccumulator::setNbEvent(), Swarm::StatAccumulator::setNbEventAboveUpperBound(), Swarm::StatAccumulator::setNbEventBelowLowerBound(), Swarm::StatAccumulator::setSum(), and Swarm::StatAccumulator::setVecHistogram().

Referenced by addDataCallableMethod(), addDataCallableMethod(), createNewCommunicationStatMap(), and getCommunicationStat().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ extraLoad()

bool BaseDaemon::extraLoad ( const ConfigNode * config )

virtualinherited

Extra call on load for the current Daemon.

Parameters

config : configuration for the current Daemon

Returns: true on success, false otherwise

Reimplemented in Swarm::Monitoring< _TBackend >.

Definition at line 108 of file BaseDaemon.cpp.

                                                   {
        return true;
}

Referenced by loadConfigFromNode().

Here is the caller graph for this function:

◆ fillDaemonStat()

void BaseDaemon::fillDaemonStat	(	Swarm::Stat &	stat,
		time_t	startTimestamp,
		time_t	endTimestamp )

Fill the Stat with the current statistics of the daemon.

Parameters

stat	Stat to be filled
startTimestamp	time at which the statistic started to be filled
endTimestamp	time at which the statistic stopped to be filled

Definition at line 157 of file BaseDaemon.cpp.

                                                                                      {
        // Fill the computing statistics
        MapStatAccumulator & mapStatComputing = p_config.getDaemonStatAccumulator().getMapStatComputing();
        for(MapStatAccumulator::iterator it = mapStatComputing.begin(); it != mapStatComputing.end(); ++it){
                StatAccumulator & accumulator = it->second;
                VecStat vecStat = fillVecStat(accumulator, startTimestamp, endTimestamp);
                stat.getMapStatComputing()[it->first] = vecStat;
        }
 
        // Fill the communication statistics
        MapDaemonStatAccumulator & mapStatCommunication = p_config.getDaemonStatAccumulator().getMapStatCommunication();
        for(MapDaemonStatAccumulator::iterator itMap = mapStatCommunication.begin(); itMap != mapStatCommunication.end(); ++itMap){
                const PString & destName = itMap->first;
                std::map<PString, VecStat> & mapVecStat = stat.getMapStatCommunication()[destName];
                for(MapStatAccumulator::iterator it = itMap->second.begin(); it != itMap->second.end(); ++it){
                        StatAccumulator & accumulator = it->second;
                        VecStat vecStat = fillVecStat(accumulator, startTimestamp, endTimestamp);
                        mapVecStat[it->first] = vecStat;
                }
        }
}

Referenced by testFillDaemonStat().

Here is the caller graph for this function:

◆ fillVecStat()

VecStat BaseDaemon::fillVecStat	(	const Swarm::StatAccumulator &	accumulator,
		time_t	startTimestamp,
		time_t	endTimestamp )

Fill a VecStat from a StatAccumulator to send to the DamonStat.

Parameters

accumulator	StatAccumulator to be converted
startTimestamp	time at which the statistic started to be filled
endTimestamp	time at which the statistic stopped to be filled

Returns: VecStat filled with the statistics from the accumulator

Definition at line 156 of file BaseDaemon.cpp.

                                                                                                              {
        VecStat vecStat;
        
        // Compute event values
        vecStat.getNbEvent().push_back(accumulator.getNbEvent());
        vecStat.getMin().push_back(accumulator.getMin());
        vecStat.getMax().push_back(accumulator.getMax());
        vecStat.getAverage().push_back(accumulator.getSum() / accumulator.getNbEvent());
 
        // Compute time values
        vecStat.getStartTimestamp().push_back(startTimestamp);
        vecStat.getEndTimestamp().push_back(endTimestamp);
        time_t rate = endTimestamp - startTimestamp;
        vecStat.getRate().push_back(accumulator.getNbEvent()*1e9 / rate);
        vecStat.getRateEventAboveUpperBound().push_back(accumulator.getNbEventAboveUpperBound()*1e9 / rate);
        vecStat.getRateEventBelowLowerBound().push_back(accumulator.getNbEventBelowLowerBound()*1e9 / rate);
        
        vecStat.getVecRateQuantile().resize(accumulator.getVecHistogram().size());
        for(size_t i = 0; i < accumulator.getVecHistogram().size(); ++i){
                vecStat.getVecRateQuantile()[i].push_back(accumulator.getVecHistogram()[i]*1e9 / rate);
        }
        return vecStat;
}

Referenced by testFillVecStat().

Here is the caller graph for this function:

◆ getCommunicationStat()

void BaseDaemon::getCommunicationStat	(	const PString &	destName,
		const PString &	dataType,
		float	latency,
		size_t	nbBin,
		float	histLowerBound,
		float	histUpperBound )

privateinherited

Add a communication statistic.

Parameters

destName	: name of the destination Daemon from which data where pushed
dataType	: type of data which where pushed
latency	: latency between the send of the data and the receiving of the confirmation by the daemon destName
nbBin	: number of bin of the histogram
histLowerBound	: lower bound of the histogram
histUpperBound	: upper bound of the histogram

Definition at line 431 of file BaseDaemon.cpp.

                                                                                                                                                                {
        std::map<PString, std::map<PString, StatAccumulator> > & mapCommunication = p_config.getDaemonStatAccumulator().getMapStatCommunication();
        MapDaemonStatAccumulator::iterator it = mapCommunication.find(destName);
        if(it == mapCommunication.end()){
                mapCommunication[destName] = createNewCommunicationStatMap(dataType, nbBin, histLowerBound, histUpperBound);
        }
        else{
                std::map<PString, StatAccumulator>::iterator itDataType = it->second.find(dataType);
                if(itDataType == it->second.end()){
                        it->second[dataType] = createNewStat(nbBin, histLowerBound, histUpperBound);
                }
        }
        updateStatAccumulator(p_config.getDaemonStatAccumulator().getMapStatCommunication().find(destName)->second[dataType], latency);
}

References createNewCommunicationStatMap(), createNewStat(), p_config, and updateStatAccumulator().

Referenced by processConfirmedMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getConfig()

DaemonConfig & BaseDaemon::getConfig ( )

inherited

Get the configuration of the current BaseDaemon.

Returns: configuration of the current BaseDaemon

Definition at line 371 of file BaseDaemon.cpp.

                                    {
        return p_config;
}

References p_config.

Referenced by Swarm::Monitoring< _TBackend >::addCallMethod(), testClearStatAccumulator(), and testFillDaemonStat().

Here is the caller graph for this function:

◆ getDataFunction()

AbstractDataFunction * BaseDaemon::getDataFunction ( const Swarm::Data & data )

inherited

Get the data function associated with the given data.

Parameters

data	The data for which to retrieve the associated function

Returns: A pointer to the associated data function, or nullptr if not found

Definition at line 268 of file BaseDaemon.cpp.

                                                                  {
        PString prototype(data.getType());
        std::map<PString, AbstractDataFunction*>::iterator it(p_mapDataFunction.find(prototype));
        if(it == p_mapDataFunction.end()){
                getLog().getLogError() << "BaseDaemon::getDataFunction : function to process data '"<<prototype<<"' not found" << std::endl;
                return nullptr;
        }
        return it->second;
}

References getLog(), Swarm::Data::getType(), and p_mapDataFunction.

Referenced by processData(), and Swarm::Daemon< _TBackend >::processInputMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLog()

PLog & BaseDaemon::getLog ( )

inherited

Get the log of the current BaseDaemon.

Returns: log of the current BaseDaemon

Definition at line 160 of file BaseDaemon.cpp.

                         {
        return p_log;
}

References p_log.

Referenced by addCallableMethod(), Swarm::Monitoring< _TBackend >::addCallMethod(), addDataCallableMethod(), addDataCallableMethod(), callMethod(), checkMessageTimeout(), getDataFunction(), Swarm::Daemon< _TBackend >::initialisationDaemonSocket(), processConfirmedMessage(), processData(), Swarm::Daemon< _TBackend >::processInputMessage(), Swarm::Daemon< _TBackend >::sendStatToStatDaemon(), and updateStatAccumulator().

Here is the caller graph for this function:

◆ getLogger()

PLog & BaseDaemon::getLogger ( )

inherited

Get the logger of the current BaseDaemon.

Returns: logger of the current BaseDaemon

Definition at line 392 of file BaseDaemon.cpp.

                            {
        return p_log;
}

References p_log.

◆ getMainConfig()

DaemonMainConfig & BaseDaemon::getMainConfig ( )

inherited

Get the main configuration of the swarm.

Returns: main configuration of the swarm

Definition at line 385 of file BaseDaemon.cpp.

                                            {
        return p_mainConfig;
}

References p_mainConfig.

◆ getMapDaemonConfig()

MapDaemonConfig & BaseDaemon::getMapDaemonConfig ( )

inherited

Get the map of all Daemon configurations.

Returns: map of all Daemon configurations

Definition at line 378 of file BaseDaemon.cpp.

                                                {
        return p_mapDaemon;
}

References p_mapDaemon.

◆ getMapMessageToBeConfirmed()

const std::map< size_t, Message > & BaseDaemon::getMapMessageToBeConfirmed ( ) const

inherited

Get the map of message to be confirmed.

Returns: map of message to be confirmed

Definition at line 349 of file BaseDaemon.cpp.

                                                                             {
        return p_mapMessageToBeConfirmed;
}

References p_mapMessageToBeConfirmed.

◆ getMessageId()

size_t BaseDaemon::getMessageId ( )

inherited

Get current message id.

Returns: current message id

Definition at line 259 of file BaseDaemon.cpp.

                               {
        ++p_messageId;
        return p_messageId;
}

References p_messageId.

Referenced by Swarm::Daemon< _TBackend >::sendData().

Here is the caller graph for this function:

◆ getMessageToConfirm()

bool BaseDaemon::getMessageToConfirm	(	Swarm::Message &	message,
		size_t	id ) const

inherited

Get a message to confirm by id if it exists.

Parameters

[out]	message	: message which has the id id
	id	: id of the message to be searched

Returns: true if the message with id id does exist, false otherwise

Definition at line 195 of file BaseDaemon.cpp.

                                                                      {
        std::map<size_t, Message>::const_iterator it(p_mapMessageToBeConfirmed.find(id));
        if(it != p_mapMessageToBeConfirmed.end()){
                message = it->second;
                return true;
        }
        return false;
}

References p_mapMessageToBeConfirmed.

Referenced by testBaseDaemonGetMessageToConfirm(), and testBaseDaemonProcessConfirmedMessage().

Here is the caller graph for this function:

◆ getOptionParser()

OptionParser & BaseDaemon::getOptionParser ( )

inherited

Return the OptionParser of the current BaseDaemon.

Returns: OptionParser of the current BaseDaemon

Definition at line 153 of file BaseDaemon.cpp.

                                          {
        return p_optionParser;
}

References p_optionParser.

◆ initialisationBaseDaemon()

void BaseDaemon::initialisationBaseDaemon ( )

privateinherited

Initialisation function of the class BaseDaemon.

Definition at line 397 of file BaseDaemon.cpp.

                                         {
        p_optionParser.setExampleLongOption("phoenix_daemon --daemonconfig=daemon_config.toml --daemonname=main");
        p_optionParser.setExampleShortOption("phoenix_daemon -c daemon_config.toml -n main");
        p_optionParser.addOption("daemonconfig", "c", OptionType::FILENAME, true, "Toml configuration file which define all Daemons of the swarm");
        p_optionParser.addOption("daemonname", "n", OptionType::STRING, true, "Name of the current Daemon of the swarm configuration defined with --daemonconfig");
        p_optionParser.addOption("mock", "m", OptionType::NONE, false, "Activate the Daemon in mock mode for the sockets and the clock");
        p_optionParser.addOption("mockrecord", "r", OptionType::NONE, false, "Activate the Daemon in mock record mode for the sockets and the clock");
        p_isRun = false;
        p_messageId = 0lu;
        p_isFullMock = false;
        p_isFullMockRecord = false;
}

References p_isFullMock, p_isFullMockRecord, p_isRun, p_messageId, and p_optionParser.

Referenced by BaseDaemon().

Here is the caller graph for this function:

◆ isDaemonExist()

bool BaseDaemon::isDaemonExist ( const PString & name ) const

inherited

Say if a neighbour Daemon does exist.

Parameters

name	: name of the Daemon to be searched

Returns: true if the Daemon does exist, false otherwise

Definition at line 168 of file BaseDaemon.cpp.

                                                        {
        MapDaemonConfig::const_iterator it(p_mapDaemon.find(name));
        if(it == p_mapDaemon.end()){
                //Then if the stat daemon does not exist in the map, it may be the current daemon
                if(p_config.getName() == name){
                        return true;
                }
        }
        if(it != p_mapDaemon.end()){
                return true;
        }
 
        return false;
}

References p_config, and p_mapDaemon.

Referenced by loadConfigFromNode(), testBaseDaemonLoadConfigJson(), testBaseDaemonLoadConfigJsonString(), testBaseDaemonLoadConfigToml(), testBaseDaemonLoadConfigTomlString(), testBaseDaemonLoadConfigYml(), testBaseDaemonLoadConfigYmlString(), and testBaseDaemonParseArgument().

Here is the caller graph for this function:

◆ load() [1/2]

bool BaseDaemon::load	(	const PPath &	fileName,
		const PString &	daemonName )

inherited

Load the Toml configuration which define all BaseDaemons of the Swarm.

Parameters

fileName	: name of the configuration file of all the BaseDaemons of the Swarm in toml format
daemonName	: name of the current BaseDaemon in the given file

Returns: true on success, false otherwise

Definition at line 97 of file BaseDaemon.cpp.

                                                                       {
        ConfigNode dico;
        daemon_load_config(p_log, dico, fileName);
        loadConfigFromNode(dico, daemonName);
        return true;
}

References daemon_load_config(), loadConfigFromNode(), and p_log.

Here is the call graph for this function:

◆ load() [2/2]

bool BaseDaemon::load	(	const PString &	configFileContent,
		const PString &	daemonName,
		ConfigFormat::ConfigFormat	format )

inherited

Load the Json configuration which define all BaseDaemons of the Swarm.

Parameters

configFileContent	: name of the configuration file of all the BaseDaemons of the Swarm in json format
daemonName	: name of the current BaseDaemon in the given file
format	: format of the configuration file

Returns: true on success, false otherwise

Definition at line 85 of file BaseDaemon.cpp.

                                                                                                                   {
        ConfigNode dico;
        daemon_load_config(p_log, dico, configFileContent, format);
        loadConfigFromNode(dico, daemonName);
        return true;
}

References daemon_load_config(), loadConfigFromNode(), and p_log.

Referenced by parseArgument(), testBaseDaemonLoadConfigJson(), testBaseDaemonLoadConfigJsonString(), testBaseDaemonLoadConfigToml(), testBaseDaemonLoadConfigTomlString(), testBaseDaemonLoadConfigYml(), testBaseDaemonLoadConfigYmlString(), testBaseDaemonMissingDaemonSectionJsonFile(), testBaseDaemonMissingDaemonSectionJsonString(), testBaseDaemonMissingDaemonSectionTomlFile(), testBaseDaemonMissingDaemonSectionTomlString(), testBaseDaemonMissingDaemonSectionYmlFile(), testBaseDaemonMissingDaemonSectionYmlString(), and testBaseDaemonProcessConfirmedMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadConfigFromNode()

void BaseDaemon::loadConfigFromNode	(	const ConfigNode &	dico,
		const PString &	daemonName )

inherited

Load configuration form a node of ConfigNode.

Parameters

[out]	dico	: loaded configuration
	daemonName	: name of the current Daemon in the configuration

Returns: true on success, false otherwise

Definition at line 47 of file BaseDaemon.cpp.

                                                                                       {
        const ConfigNode * mapMainConfig = dico.getChild("swarm");
        if(mapMainConfig != nullptr){
                p_mainConfig.recvTimeoutMs = phoenix_get_value<int>(*mapMainConfig, "recv_timeout_ms", -1);
                p_mainConfig.sendTimeoutMs = phoenix_get_value<int>(*mapMainConfig, "send_timeout_ms", -1);
                p_mainConfig.recvFlag = fromString<PRecvFlag::PRecvFlag>(phoenix_get_string(*mapMainConfig, "recv_flag", "NON_BLOCK"));
                p_mainConfig.sendFlag = fromString<PSendFlag::PSendFlag>(phoenix_get_string(*mapMainConfig, "send_flag", "NON_BLOCK"));
        }
        std::map<PString, time_t> mapTimeout;
        const ConfigNode * extraConfigParam = nullptr;
        daemon_read_configNode(p_config, p_mapDaemon, p_log, mapTimeout, extraConfigParam, dico, daemonName);
        
        const ConfigNode * mapStatDaemon = dico.getChild("statistics");
        if(mapStatDaemon != nullptr){
                p_config.setStatDaemonName(daemon_loadString(*mapStatDaemon, "stat_daemon_name"));
                extraLoad(mapStatDaemon);
        }
        p_config.setMapTimeout(mapTimeout);
        if(p_config.getStatDaemonName() != ""){
                if(!isDaemonExist(p_config.getStatDaemonName())){
                        p_log.getLogError() << "BaseDaemon::loadConfigFromNode : stat daemon '"<<p_config.getStatDaemonName()<<"' not found in configuration" << std::endl;
                }
        }
 
        p_log.getLogInfo() << "BaseDaemon::loadConfigFromNode : loading configuration successful" << std::endl;
        p_log.getLogInfo() << "BaseDaemon::loadConfigFromNode : ready to call addCallMethod to subscribe on received data" << std::endl;
        addCallMethod();
        if(extraConfigParam != nullptr){
                extraLoad(extraConfigParam);
        }
}

References addCallMethod(), daemon_loadString(), daemon_read_configNode(), extraLoad(), isDaemonExist(), p_config, p_log, p_mainConfig, and p_mapDaemon.

Referenced by load(), and load().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseArgument()

bool BaseDaemon::parseArgument	(	int	argc,
		char **	argv )

inherited

Parse arguments given to the BaseDaemon with command line.

Parameters

argc	: number of arguments given to the program
argv	: list of arguments given to the program

Returns: true on success, false otherwise

Definition at line 30 of file BaseDaemon.cpp.

                                                   {
        p_optionParser.parseArgument(argc, argv);
        const OptionMode & defaultMode = p_optionParser.getDefaultMode();
        PPath configurationFile;
        defaultMode.getValue(configurationFile, "daemonconfig");
        PString daemonName;
        defaultMode.getValue(daemonName, "daemonname");
        p_isFullMock = defaultMode.isOptionExist("mock");
        p_isFullMockRecord = defaultMode.isOptionExist("mockrecord");
        return load(configurationFile, daemonName);
}

References load(), p_isFullMock, p_isFullMockRecord, and p_optionParser.

Referenced by testBaseDaemonParseArgument().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processConfirmedMessage()

void BaseDaemon::processConfirmedMessage	(	size_t	id,
		time_t	currentTime )

inherited

Process confirmed message.

Parameters

id	: id of the message to be removed
currentTime	: time when the confirmation was received

Definition at line 208 of file BaseDaemon.cpp.

                                                                     {
        std::map<size_t, Message>::const_iterator it(p_mapMessageToBeConfirmed.find(id));
        if(it != p_mapMessageToBeConfirmed.end()){
                getLog().getLogInfo() << "BaseDaemon::processConfirmedMessage : adding statistics for processed transaction " << id << std::endl;
                const Message & message = it->second;
                time_t ellapsedTime = currentTime - message.getSendTime();
                for(const PString & receiver : message.getVecRecver()){
                        getLog().getLogDebug() << "BaseDaemon::processConfirmedMessage : add statistic for receiver : " << receiver << std::endl;
                        getCommunicationStat(receiver, message.getData().getType(), ellapsedTime, p_config.getStatNbBin(), p_config.getStatHistLowerBound(), p_config.getStatHistUpperBound());
                }
                // Remove the confirmed message
                getLog().getLogInfo() << "BaseDaemon::removeConfirmedMessage : remove confirmed transaction " << id << std::endl;
                p_mapMessageToBeConfirmed.erase(it);
        }else{
                getLog().getLogError() << "BaseDaemon::processConfirmedMessage : transaction " << id << " not found in p_mapMessageToBeConfirmed" << std::endl;
        }
}

References getCommunicationStat(), Swarm::Message::getData(), getLog(), Swarm::Message::getSendTime(), Swarm::Data::getType(), Swarm::Message::getVecRecver(), p_config, and p_mapMessageToBeConfirmed.

Referenced by Swarm::Daemon< _TBackend >::processInputMessage(), and testBaseDaemonProcessConfirmedMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processData()

bool BaseDaemon::processData ( const Swarm::Data & data )

inherited

Process given data with the proper method.

Parameters

data	: data to be processed

Returns: true on success, false otherwise

Definition at line 282 of file BaseDaemon.cpp.

                                             {
        AbstractDataFunction* function = getDataFunction(data);
        if(function == nullptr){
                return false;
        }
        getLog().getLogDebug() << "BaseDaemon::processData : process data '"<<data.getType()<<"'" << std::endl;
        bool b = function->call(p_log, data);
        return b;
}

References Swarm::AbstractDataFunction::call(), getDataFunction(), getLog(), Swarm::Data::getType(), and p_log.

Here is the call graph for this function:

◆ stop()

void BaseDaemon::stop ( )

inherited

Stops the BaseDaemon.

Definition at line 145 of file BaseDaemon.cpp.

                     {
        p_log.getLogInfo() << "Stopping Daemon '"<<p_config.getName()<<"' at '"<<p_config.getHostName()<<"'" << std::endl;
        p_isRun = false;
}

References p_config, p_isRun, and p_log.

Referenced by Swarm::Daemon< _TBackend >::processInputMessage(), and testBaseDaemonParseArgument().

Here is the caller graph for this function:

◆ updateStatAccumulator()

void BaseDaemon::updateStatAccumulator	(	StatAccumulator &	stat,
		float	value )

inherited

Update a computing statistic with a new value.

Parameters

stat	: statistic to be updated
value	: new value to be added to the statistic

Definition at line 296 of file BaseDaemon.cpp.

                                                                         {
        stat.setNbEvent(stat.getNbEvent() + 1lu);
        getLog().getLogDebug() << "BaseDaemon::updateStatAccumulator : event nb is " << stat.getNbEvent() << std::endl;
        if(stat.getNbEvent() == 1lu){
                stat.setMin(value);
                stat.setMax(value);
                stat.setSum(value);
        }else{
                if(value < stat.getMin()){
                        stat.setMin(value);
                }
                if(value > stat.getMax()){
                        stat.setMax(value);
                }
                stat.setSum(stat.getSum() + value);
        }
        if(value > stat.getHistUpperBound()){
                stat.setNbEventAboveUpperBound(stat.getNbEventAboveUpperBound() + 1lu);
        }
        if(value < stat.getHistLowerBound()){
                stat.setNbEventBelowLowerBound(stat.getNbEventBelowLowerBound() + 1lu);
        }
        float binSize = (stat.getHistUpperBound() - stat.getHistLowerBound()) / stat.getVecHistogram().size();
        size_t bin = (value - stat.getHistLowerBound()) / binSize;
        if(bin < stat.getVecHistogram().size()){
                std::vector<size_t> & vecHistogram = stat.getVecHistogram();
                vecHistogram[bin] = vecHistogram[bin] + 1lu;
        }
}

Referenced by getCommunicationStat(), Swarm::Daemon< _TBackend >::processInputMessage(), and testUpdateStatAccumulator().

Here is the call graph for this function:

Here is the caller graph for this function:

Referenced by BaseDaemon(), getOptionParser(), initialisationBaseDaemon(), and parseArgument().

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

/builds/CTA-LAPP/PHOENIX_LIBS2/network/PhoenixSwarm/build/doc/platex/TESTS/TEST_DAEMONS/TEST_BASEDAEMON/main.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addCallableMethod()

◆ addCallMethod()

◆ addDataCallableMethod() [1/2]

◆ addDataCallableMethod() [2/2]

◆ addMessageToConfirm()

◆ callMethod()

◆ checkMessageTimeout()

◆ clearCallableMethod()

◆ clearStat()

◆ createNewCommunicationStatMap()

◆ createNewStat()

◆ extraLoad()

◆ fillDaemonStat()

◆ fillVecStat()

◆ getCommunicationStat()

◆ getConfig()

◆ getDataFunction()

◆ getLog()

◆ getLogger()

◆ getMainConfig()

◆ getMapDaemonConfig()

◆ getMapMessageToBeConfirmed()

◆ getMessageId()

◆ getMessageToConfirm()

◆ getOptionParser()

◆ initialisationBaseDaemon()

◆ isDaemonExist()

◆ load() [1/2]

◆ load() [2/2]

◆ loadConfigFromNode()

◆ parseArgument()

◆ processConfirmedMessage()

◆ processData()

◆ stop()

◆ updateStatAccumulator()

Member Data Documentation

◆ p_config

◆ p_isFullMock

◆ p_isFullMockRecord

◆ p_isRun

◆ p_log

◆ p_mainConfig

◆ p_mapCallableMethod

◆ p_mapDaemon

◆ p_mapDataFunction

◆ p_mapMessageToBeConfirmed

◆ p_messageId

◆ p_optionParser