#include <CbmMqHistoServer.h>

Inheritance diagram for CbmMqHistoServer:

Collaboration diagram for CbmMqHistoServer:

Public Member Functions
	CbmMqHistoServer ()

virtual	~CbmMqHistoServer ()

void	UpdateHttpServer ()

Protected Member Functions
virtual void	InitTask ()

bool	ReceiveData (FairMQMessagePtr &msg, int index)

bool	ReceiveHistoConfig (FairMQMessagePtr &msg, int index)

bool	ReceiveCanvasConfig (FairMQMessagePtr &msg, int index)

bool	ReceiveConfigAndData (FairMQParts &msg, int index)

virtual void	PreRun ()

virtual void	PostRun ()

Private Member Functions
template<class HistoT >
bool	ReadHistogram (HistoT *pHist)

int	FindHistogram (const std::string &name)

bool	PrepareCanvas (uint32_t uCanvIdx)

bool	ResetHistograms ()

bool	SaveHistograms ()

Private Attributes
std::string	fsChannelNameHistosInput = "histogram-in"
	Parameters.

std::string	fsChannelNameHistosConfig = "histo-conf"

std::string	fsChannelNameCanvasConfig = "canvas-conf"

std::string	fsHistoFileName = "MqHistos.root"

uint32_t	fuHttpServerPort = 8098

TObjArray	fArrayHisto
	Array of histograms with unique names.

std::vector< std::pair< std::string, std::string > >	fvpsHistosFolder = {}
	Vector of string with ( HistoName, FolderPath ) to send to the histogram server.

std::vector< std::pair< std::string, std::string > >	fvpsCanvasConfig = {}

std::vector< bool >	fvbCanvasReady = {}

bool	fbAllCanvasReady = false

std::vector< std::pair< TNamed *, std::string > >	fvHistos = {}

std::vector< bool >	fvbHistoRegistered = {}
	Vector of Histos pointers and folder path.

bool	fbAllHistosRegistered = false

std::vector< std::pair< TCanvas *, std::string > >	fvCanvas = {}

std::vector< bool >	fvbCanvasRegistered = {}
	Vector of Canvas pointers and folder path.

bool	fbAllCanvasRegistered = false

int	fNMessages = 0
	Internal status.

THttpServer *	fServer = nullptr

std::thread	fThread

bool	fStopThread = false

Detailed Description

Definition at line 20 of file CbmMqHistoServer.h.

Constructor & Destructor Documentation

◆ CbmMqHistoServer()

CbmMqHistoServer::CbmMqHistoServer ( )

Definition at line 36 of file CbmMqHistoServer.cxx.

◆ ~CbmMqHistoServer()

CbmMqHistoServer::~CbmMqHistoServer ( )

virtual

Definition at line 42 of file CbmMqHistoServer.cxx.

Member Function Documentation

◆ FindHistogram()

int CbmMqHistoServer::FindHistogram ( const std::string & name )

private

Definition at line 358 of file CbmMqHistoServer.cxx.

References fArrayHisto.

Referenced by PrepareCanvas(), and ReadHistogram().

◆ InitTask()

void CbmMqHistoServer::InitTask ( )

protectedvirtual

Read options from executable

Link channels to methods in order to process received messages

If multi-parts, go to method processing combined Config+Data

To avoid the server sucking all Histos from gROOT when no output file is used

Definition at line 44 of file CbmMqHistoServer.cxx.

References fsChannelNameCanvasConfig, fsChannelNameHistosConfig, fsChannelNameHistosInput, fServer, fsHistoFileName, fuHttpServerPort, ReceiveCanvasConfig(), ReceiveConfigAndData(), ReceiveData(), and ReceiveHistoConfig().

◆ PostRun()

void CbmMqHistoServer::PostRun ( )

protectedvirtual

Definition at line 297 of file CbmMqHistoServer.cxx.

References fStopThread, fThread, and SaveHistograms().

◆ PrepareCanvas()

bool CbmMqHistoServer::PrepareCanvas ( uint32_t uCanvIdx )

private

First check if all objects to be drawn are present

Check for empty pads!

Create new canvas and pads

Loop on pads

Pad settings

Add objects (we know they are there

Update flag telling whether all known canvases are registered

Definition at line 374 of file CbmMqHistoServer.cxx.

References ExtractCanvasConfigFromString(), fArrayHisto, fbAllCanvasRegistered, FindHistogram(), fServer, fvbCanvasRegistered, fvCanvas, fvpsCanvasConfig, CanvasConfig::GetGridx(), CanvasConfig::GetGridy(), CanvasConfig::GetLogx(), CanvasConfig::GetLogy(), CanvasConfig::GetLogz(), CanvasConfig::GetName(), CanvasConfig::GetNbObjsInPad(), CanvasConfig::GetNbPads(), CanvasConfig::GetNbPadsX(), CanvasConfig::GetNbPadsY(), CanvasConfig::GetObjName(), CanvasConfig::GetOption(), and CanvasConfig::GetTitle().

Referenced by ReceiveData().

◆ PreRun()

void CbmMqHistoServer::PreRun ( )

protectedvirtual

Definition at line 281 of file CbmMqHistoServer.cxx.

References fStopThread, fThread, and UpdateHttpServer().

◆ ReadHistogram()

template<class HistoT >

bool CbmMqHistoServer::ReadHistogram ( HistoT * pHist )

private

If new histo received, try to register it if configuration available

Jump histos already ready

Check if name matches one in config for others

Update flag telling whether all known histos are registered

Definition at line 306 of file CbmMqHistoServer.cxx.

References fArrayHisto, fbAllHistosRegistered, FindHistogram(), first, fServer, fvbHistoRegistered, fvHistos, and fvpsHistosFolder.

Referenced by ReceiveData().

◆ ReceiveCanvasConfig()

bool CbmMqHistoServer::ReceiveCanvasConfig	(	FairMQMessagePtr &	msg,
		int	index )

protected

Check if canvas name already received in previous messages Linear search should be ok as config is shared only at startup

Not sure if we should return false here...

Definition at line 180 of file CbmMqHistoServer.cxx.

References fbAllCanvasReady, fbAllCanvasRegistered, first, fvbCanvasReady, fvbCanvasRegistered, fvCanvas, and fvpsCanvasConfig.

Referenced by InitTask(), and ReceiveConfigAndData().

◆ ReceiveConfigAndData()

bool CbmMqHistoServer::ReceiveConfigAndData	(	FairMQParts &	msg,
		int	index )

protected

Reject anything but a at least Header + Histo Config + Canvas Config + Histo Data

PAL, 09/04/2021, Debug message catching missed method overload/polymorphism: contrary to my expectation, if 2 method bound to same channel, one with FairMQMessagePtr and one with FairMQParts, all messages go to multipart version and FairMQMessagePtr is converted to size 1 FairMQParts

Header contains a pair of

Decode parts for histograms configuration

Decode the histograms data now that the configuration is loaded

Definition at line 213 of file CbmMqHistoServer.cxx.

References ReceiveCanvasConfig(), ReceiveData(), and ReceiveHistoConfig().

Referenced by InitTask().

◆ ReceiveData()

bool CbmMqHistoServer::ReceiveData	(	FairMQMessagePtr &	msg,
		int	index )

protected

Need to use Delete instead of Clear to avoid memory leak!!!

If new histos received, try to prepare as many canvases as possible Should be expensive on start and cheap afterward

Jump canvases already ready

Now come the expensive part as we unpack its config and check each histo

Definition at line 76 of file CbmMqHistoServer.cxx.

References fbAllCanvasReady, fNMessages, fvbCanvasReady, fvpsCanvasConfig, mtx, PrepareCanvas(), and ReadHistogram().

Referenced by InitTask(), and ReceiveConfigAndData().

◆ ReceiveHistoConfig()

bool CbmMqHistoServer::ReceiveHistoConfig	(	FairMQMessagePtr &	msg,
		int	index )

protected

Check if histo name already received in previous messages Linear search should be ok as config is shared only at startup

Not sure if we should return false here...

Definition at line 148 of file CbmMqHistoServer.cxx.

References fbAllHistosRegistered, first, fvbHistoRegistered, fvHistos, and fvpsHistosFolder.

Referenced by InitTask(), and ReceiveConfigAndData().

◆ ResetHistograms()

bool CbmMqHistoServer::ResetHistograms ( )

private

Definition at line 367 of file CbmMqHistoServer.cxx.

References fArrayHisto.

◆ SaveHistograms()

bool CbmMqHistoServer::SaveHistograms ( )

private

Save old global file and folder pointer to avoid messing with FairRoot

(Re-)Create ROOT file to store the histos

Register the histos in the HTTP server

Make sure we end up in chosen folder

Write plot

Make sure we end up in chosen folder

Write plot

Restore old global file and folder pointer to avoid messing with FairRoot

Definition at line 454 of file CbmMqHistoServer.cxx.

References fsHistoFileName, fvCanvas, and fvHistos.

Referenced by PostRun().

◆ UpdateHttpServer()

void CbmMqHistoServer::UpdateHttpServer ( )

Definition at line 287 of file CbmMqHistoServer.cxx.

References fServer, fStopThread, and mtx.

Referenced by PreRun().

Member Data Documentation

◆ fArrayHisto

TObjArray CbmMqHistoServer::fArrayHisto

private

Array of histograms with unique names.

Definition at line 52 of file CbmMqHistoServer.h.

Referenced by FindHistogram(), PrepareCanvas(), ReadHistogram(), and ResetHistograms().

◆ fbAllCanvasReady

bool CbmMqHistoServer::fbAllCanvasReady = false

private

Definition at line 60 of file CbmMqHistoServer.h.

Referenced by ReceiveCanvasConfig(), and ReceiveData().

◆ fbAllCanvasRegistered

bool CbmMqHistoServer::fbAllCanvasRegistered = false

private

Definition at line 67 of file CbmMqHistoServer.h.

Referenced by PrepareCanvas(), and ReceiveCanvasConfig().

◆ fbAllHistosRegistered

bool CbmMqHistoServer::fbAllHistosRegistered = false

private

Definition at line 64 of file CbmMqHistoServer.h.

Referenced by ReadHistogram(), and ReceiveHistoConfig().

◆ fNMessages

int CbmMqHistoServer::fNMessages = 0

private

Internal status.

Definition at line 70 of file CbmMqHistoServer.h.

Referenced by ReceiveData().

◆ fsChannelNameCanvasConfig

std::string CbmMqHistoServer::fsChannelNameCanvasConfig = "canvas-conf"

private

Definition at line 47 of file CbmMqHistoServer.h.

Referenced by InitTask().

◆ fsChannelNameHistosConfig

std::string CbmMqHistoServer::fsChannelNameHistosConfig = "histo-conf"

private

Definition at line 46 of file CbmMqHistoServer.h.

Referenced by InitTask().

◆ fsChannelNameHistosInput

std::string CbmMqHistoServer::fsChannelNameHistosInput = "histogram-in"

private

Parameters.

Definition at line 45 of file CbmMqHistoServer.h.

Referenced by InitTask().

◆ fServer

THttpServer* CbmMqHistoServer::fServer = nullptr

private

Definition at line 72 of file CbmMqHistoServer.h.

Referenced by InitTask(), PrepareCanvas(), ReadHistogram(), and UpdateHttpServer().

◆ fsHistoFileName

std::string CbmMqHistoServer::fsHistoFileName = "MqHistos.root"

private

Definition at line 48 of file CbmMqHistoServer.h.

Referenced by InitTask(), and SaveHistograms().

◆ fStopThread

bool CbmMqHistoServer::fStopThread = false

private

Definition at line 75 of file CbmMqHistoServer.h.

Referenced by PostRun(), PreRun(), and UpdateHttpServer().

◆ fThread

std::thread CbmMqHistoServer::fThread

private

Definition at line 74 of file CbmMqHistoServer.h.

Referenced by PostRun(), and PreRun().

◆ fuHttpServerPort

uint32_t CbmMqHistoServer::fuHttpServerPort = 8098

private

Definition at line 49 of file CbmMqHistoServer.h.

Referenced by InitTask().

◆ fvbCanvasReady

std::vector<bool> CbmMqHistoServer::fvbCanvasReady = {}

private

Definition at line 59 of file CbmMqHistoServer.h.

Referenced by ReceiveCanvasConfig(), and ReceiveData().

◆ fvbCanvasRegistered

std::vector<bool> CbmMqHistoServer::fvbCanvasRegistered = {}

private

Vector of Canvas pointers and folder path.

Definition at line 66 of file CbmMqHistoServer.h.

Referenced by PrepareCanvas(), and ReceiveCanvasConfig().

◆ fvbHistoRegistered

std::vector<bool> CbmMqHistoServer::fvbHistoRegistered = {}

private

Vector of Histos pointers and folder path.

Definition at line 63 of file CbmMqHistoServer.h.

Referenced by ReadHistogram(), and ReceiveHistoConfig().

◆ fvCanvas

std::vector<std::pair<TCanvas*, std::string> > CbmMqHistoServer::fvCanvas = {}

private

Definition at line 65 of file CbmMqHistoServer.h.

Referenced by PrepareCanvas(), ReceiveCanvasConfig(), and SaveHistograms().

◆ fvHistos

std::vector<std::pair<TNamed*, std::string> > CbmMqHistoServer::fvHistos = {}

private

Definition at line 62 of file CbmMqHistoServer.h.

Referenced by ReadHistogram(), ReceiveHistoConfig(), and SaveHistograms().

◆ fvpsCanvasConfig

std::vector<std::pair<std::string, std::string> > CbmMqHistoServer::fvpsCanvasConfig = {}

private

Vector of string pairs with ( CanvasName, CanvasConfig ) to send to the histogram server Format of Can config is "Name;Title;NbPadX(U);NbPadY(U);ConfigPad1(s);....;ConfigPadXY(s)" Format of Pad config is "GrixX(b),GridY(b),LogX(b),LogY(b),LogZ(b),HistoName(s),DrawOptions(s)"

Definition at line 58 of file CbmMqHistoServer.h.

Referenced by PrepareCanvas(), ReceiveCanvasConfig(), and ReceiveData().

◆ fvpsHistosFolder

std::vector<std::pair<std::string, std::string> > CbmMqHistoServer::fvpsHistosFolder = {}

private

Vector of string with ( HistoName, FolderPath ) to send to the histogram server.

Definition at line 54 of file CbmMqHistoServer.h.

Referenced by ReadHistogram(), and ReceiveHistoConfig().

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CbmMqHistoServer()

◆ ~CbmMqHistoServer()

Member Function Documentation

◆ FindHistogram()

◆ InitTask()

◆ PostRun()

◆ PrepareCanvas()

◆ PreRun()

◆ ReadHistogram()

◆ ReceiveCanvasConfig()

◆ ReceiveConfigAndData()

◆ ReceiveData()

◆ ReceiveHistoConfig()

◆ ResetHistograms()

◆ SaveHistograms()

◆ UpdateHttpServer()

Member Data Documentation

◆ fArrayHisto

◆ fbAllCanvasReady

◆ fbAllCanvasRegistered

◆ fbAllHistosRegistered

◆ fNMessages

◆ fsChannelNameCanvasConfig

◆ fsChannelNameHistosConfig

◆ fsChannelNameHistosInput

◆ fServer

◆ fsHistoFileName

◆ fStopThread

◆ fThread

◆ fuHttpServerPort

◆ fvbCanvasReady

◆ fvbCanvasRegistered

◆ fvbHistoRegistered

◆ fvCanvas

◆ fvHistos

◆ fvpsCanvasConfig

◆ fvpsHistosFolder