Slot of CoreQueueMultiReceiver, receiving from CoreQueueNotifier. More...

#include "core_queue_slot.h"

Inheritance diagram for hh::core::CoreQueueSlot:

Collaboration diagram for hh::core::CoreQueueSlot:

Public Member Functions
	CoreQueueSlot (std::string_view const &name, NodeType const type, size_t const numberThreads)
	CoreQueueSlot constructor. More...

	~CoreQueueSlot () override
	CoreQueueSlot destructor.

std::shared_ptr< std::condition_variable > const &	notifyConditionVariable () const
	Condition variable accessor. More...

std::shared_ptr< std::mutex > const &	slotMutex () const
	Mutex accessor. More...

size_t	numberInputNodes () const final
	Number of CoreNotifier linked accessor. More...

void	addNotifier (CoreNotifier *notifier) final
	Add a notifier to set of CoreNotifier. More...

void	removeNotifier (CoreNotifier *notifier) final
	Remove a notifier from set of CoreNotifier. More...

bool	hasNotifierConnected () final
	Test if CoreNotifier are linked to this CoreQueueSlot. More...

void	wakeUp () final
	Wake up and notify a node connected to the condition variable CoreQueueSlot::notifyConditionVariable_.

void	lockUniqueMutex ()
	Lock the mutex.

void	unlockUniqueMutex ()
	Unlock the mutex.

void	copyInnerStructure (CoreQueueSlot *rhs)
	Copy the inner structure of the receiver (mutex, condition variable and set of notifiers) More...

Public Member Functions inherited from hh::core::CoreSlot
	CoreSlot (std::string_view const &name, NodeType const type, size_t const numberThreads)
	Core slot constructor. More...

	~CoreSlot () override
	Core Slot destructor.

virtual bool	waitForNotification ()=0
	Interface to define how the node wait for a signal, and return if the node is terminated. More...

Public Member Functions inherited from hh::core::CoreNode
	CoreNode ()=delete
	Deleted default constructor.

	CoreNode (std::string_view const &name, NodeType const type, size_t numberThreads)
	Core node only constructor. More...

virtual	~CoreNode ()
	Default virtual destructor.

virtual std::shared_ptr< CoreNode >	clone ()=0
	Virtual constructor for copy. More...

virtual std::string	id () const
	Unique Id accessor. More...

virtual std::vector< std::pair< std::string, std::string > >	ids () const
	Input node ids [nodeId, nodeIdCluster] accessor. More...

std::string_view const &	name () const
	Node name accessor. More...

NodeType	type () const
	Node type accessor. More...

bool	isInside () const
	Node inside property accessor. More...

bool	hasBeenRegistered () const
	Node registration property accessor. More...

CoreNode *	coreClusterNode () const
	Main cluster core node link to this node accessor. More...

int	threadId () const
	Thread id accessor. More...

size_t	numberThreads () const
	Number of threads associated accessor. More...

CoreNode *	belongingNode () const
	Belonging node accessor. More...

std::shared_ptr< std::multimap< CoreNode *, std::shared_ptr< CoreNode > > > const &	insideNodes () const
	Inside node accessor. More...

std::shared_ptr< std::multimap< CoreNode *, std::shared_ptr< CoreNode > > > &	insideNodes ()
	Inside nodes accessor. More...

std::chrono::duration< uint64_t, std::micro > const &	executionTime () const
	Execution time accessor. More...

std::chrono::duration< uint64_t, std::micro > const &	waitTime () const
	Wait time accessor. More...

std::chrono::duration< uint64_t, std::micro > const &	memoryWaitTime () const
	Memory wait time accessor. More...

bool	isInCluster () const
	In cluster property accessor. More...

bool	isActive () const
	Is active property accessor. More...

bool	isCudaRelated () const
	Is related to CUDA, used to have a green background on the dot file. More...

virtual int	graphId ()
	Graph id accessor. More...

virtual int	deviceId ()
	Device id accessor. More...

virtual std::chrono::duration< uint64_t, std::micro >	maxExecutionTime () const
	Maximum execution time accessor. More...

virtual std::chrono::duration< uint64_t, std::micro >	minExecutionTime () const
	Minimum execution time accessor. More...

virtual std::chrono::duration< uint64_t, std::micro >	maxWaitTime () const
	Maximum waiting time accessor. More...

virtual std::chrono::duration< uint64_t, std::micro >	minWaitTime () const
	Minimum waiting time accessor. More...

std::chrono::time_point< std::chrono::high_resolution_clock > const &	creationTimeStamp () const
	Creation timestamp accessor. More...

std::chrono::time_point< std::chrono::high_resolution_clock > const &	startExecutionTimeStamp () const
	Execution start timestamp accessor. More...

std::chrono::duration< uint64_t, std::micro > const &	creationDuration () const
	Creation duration accessor. More...

std::chrono::duration< uint64_t, std::micro > const &	executionDuration () const
	Execution duration accessor. More...

std::chrono::duration< uint64_t, std::micro >	meanExecTimeCluster () const
	Compute and return the mean execution time for all tasks in the node cluster. More...

std::chrono::duration< uint64_t, std::micro >	meanWaitTimeCluster () const
	Compute and return the mean wait time for all tasks in the node cluster. More...

std::chrono::duration< uint64_t, std::micro >	meanMemoryWaitTimeCluster () const
	Compute and return the mean memory wait time for all tasks in the node cluster. More...

uint64_t	stdvExecTimeCluster () const
	Compute and return the standard deviation execution time for all tasks in the node cluster. More...

uint64_t	stdvWaitTimeCluster () const
	Compute and return the standard deviation wait time for all tasks in the node cluster. More...

uint64_t	stdvMemoryWaitTimeCluster () const
	Compute and return the standard deviation memory wait time for all tasks in the node cluster. More...

std::pair< uint64_t, uint64_t >	minmaxWaitTimeCluster () const
	Compute and return the min and max wait time for all tasks in the node cluster. More...

std::pair< uint64_t, uint64_t >	minmaxMemoryWaitTimeCluster () const
	Compute and return the min and max memory wait time for all tasks in the node cluster. More...

std::pair< uint64_t, uint64_t >	minmaxExecTimeCluster () const
	Compute and return the min and max execution time for all tasks in the node cluster. More...

size_t	numberActiveThreadInCluster () const
	Compute and return the number of active nodes in a cluster. More...

virtual std::string	extraPrintingInformation ()
	Extra printing information accessor. More...

void	startExecutionTimeStamp (std::chrono::time_point< std::chrono::high_resolution_clock > const &startExecutionTimeStamp)
	Execution timestamp setter. More...

virtual void	deviceId (int deviceId)
	Device id setter. More...

virtual void	setInside ()
	Set the node as inside, (inside a graph)

void	setInCluster ()
	Set the task as part of a cluster.

void	threadId (uint8_t threadId)
	Set the thread id. More...

void	coreClusterNode (CoreNode *coreClusterNode)
	Set the main cluster node to associate to this node. More...

void	name (std::string_view const &name)
	Name node setter. More...

void	numberThreads (size_t numberThreads)
	Number of threads setter. More...

void	belongingNode (CoreNode *belongingNode)
	Belonging node setter. More...

void	hasBeenRegistered (bool hasBeenRegistered)
	Has been registered property setter. More...

void	isActive (bool isActive)
	Is active property setter. More...

void	isCudaRelated (bool isCudaRelated)
	Is CUDA related property setter. More...

void	isInside (bool isInside)
	Set the node as being inside another one. More...

void	creationDuration (std::chrono::duration< uint64_t, std::micro > const &creationDuration)
	Creation duration setter. More...

void	executionDuration (std::chrono::duration< uint64_t, std::micro > const &executionDuration)
	Execution duration setter. More...

void	incrementWaitForMemoryDuration (std::chrono::duration< uint64_t, std::micro > const &memoryWait)
	Add wait for memory duration to total duration. More...

virtual void	preRun ()
	Method defining what to do before the run.

virtual void	run ()
	Run method, main execution.

virtual void	postRun ()
	Method defining what to do after the run.

virtual void	createCluster (std::shared_ptr< std::multimap< CoreNode *, std::shared_ptr< CoreNode >>> &)
	Define how to create a cluster for the node, by default do nothing.

virtual void	joinThreads ()
	Define what is done when the thread is joined.

virtual void	duplicateEdge (CoreNode duplicateNode, std::map< CoreNode , std::shared_ptr< CoreNode >> &correspondenceMap)=0
	Duplicate all of the edges from this to its copy duplicateNode. More...

virtual behavior::Node *	node ()=0
	User's node accessor. More...

virtual void	visit (AbstractPrinter *printer)=0
	Abstract visit method for printing mechanism. More...

virtual std::set< CoreSlot * >	getSlots ()=0
	Slots accessor for the node. More...

void	removeInsideNode (CoreNode *coreNode)
	Remove a node from the registered inside nodes. More...

void	copyInnerStructure (CoreNode *rhs)
	Copy inner structure from rhs nodes to this. More...

Protected Member Functions
std::shared_ptr< std::set< CoreNotifier * > > const &	notifiers () const
	Protected accessor to the set of notifiers connected to the CoreQueueSlot. More...

Protected Member Functions inherited from hh::core::CoreNode
void	addUniqueInsideNode (const std::shared_ptr< CoreNode > &coreNode)
	Add a node to the inside nodes. More...

void	incrementWaitDuration (std::chrono::duration< uint64_t, std::micro > const &wait)
	Increment wait duration. More...

void	incrementExecutionDuration (std::chrono::duration< uint64_t, std::micro > const &exec)
	Increment execution duration. More...

Private Attributes
std::shared_ptr< std::mutex >	slotMutex_ = nullptr
	Mutex locking the CoreQueueMultiReceiver.

std::shared_ptr< std::condition_variable >	notifyConditionVariable_ = nullptr
	Condition Variable linked to the CoreQueueSlot::slotMutex_.

std::shared_ptr< std::set< CoreNotifier * > >	notifiers_ = nullptr
	Set of notifiers linked to this CoreQueueSlot.

Detailed Description

Slot of CoreQueueMultiReceiver, receiving from CoreQueueNotifier.

Definition at line 34 of file core_queue_slot.h.

Constructor & Destructor Documentation

◆ CoreQueueSlot()

hh::core::CoreQueueSlot::CoreQueueSlot	(	std::string_view const &	name,
		NodeType const	type,
		size_t const	numberThreads
	)

inline

CoreQueueSlot constructor.

Parameters

name	Node's name
type	Node's type
numberThreads	Node's number of thread

Definition at line 47 of file core_queue_slot.h.

Member Function Documentation

◆ addNotifier()

void hh::core::CoreQueueSlot::addNotifier ( CoreNotifier * notifier )

inlinefinalvirtual

Add a notifier to set of CoreNotifier.

Attention: Thread safe

Parameters

notifier CoreNotifier to add

Implements hh::core::CoreSlot.

Definition at line 76 of file core_queue_slot.h.

Here is the call graph for this function:

◆ copyInnerStructure()

void hh::core::CoreQueueSlot::copyInnerStructure ( CoreQueueSlot * rhs )

inline

Copy the inner structure of the receiver (mutex, condition variable and set of notifiers)

Parameters

rhs	CoreQueueSlot to copy to this

Definition at line 118 of file core_queue_slot.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasNotifierConnected()

bool hh::core::CoreQueueSlot::hasNotifierConnected ( )

inlinefinalvirtual

Test if CoreNotifier are linked to this CoreQueueSlot.

Attention: Not thread safe

Returns: True if CoreNotifier are linked to this CoreQueueSlot, else False

Implements hh::core::CoreSlot.

Definition at line 92 of file core_queue_slot.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ notifiers()

std::shared_ptr<std::set<CoreNotifier *> > const& hh::core::CoreQueueSlot::notifiers ( ) const

inlineprotected

Protected accessor to the set of notifiers connected to the CoreQueueSlot.

Returns: Set of notifiers connected to the CoreQueueSlot

Definition at line 128 of file core_queue_slot.h.

Here is the caller graph for this function:

◆ notifyConditionVariable()

std::shared_ptr<std::condition_variable> const& hh::core::CoreQueueSlot::notifyConditionVariable ( ) const

inline

Condition variable accessor.

Returns: Condition variable

Definition at line 60 of file core_queue_slot.h.

Here is the caller graph for this function:

◆ numberInputNodes()

size_t hh::core::CoreQueueSlot::numberInputNodes ( ) const

inlinefinalvirtual

Number of CoreNotifier linked accessor.

Attention: Not thread safe

Returns: Number of CoreNotifier linked

Implements hh::core::CoreSlot.

Definition at line 71 of file core_queue_slot.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeNotifier()

void hh::core::CoreQueueSlot::removeNotifier ( CoreNotifier * notifier )

inlinefinalvirtual

Remove a notifier from set of CoreNotifier.

Attention: Thread safe

Parameters

notifier CoreNotifier to remove

Implements hh::core::CoreSlot.

Definition at line 84 of file core_queue_slot.h.

Here is the call graph for this function:

◆ slotMutex()

std::shared_ptr<std::mutex> const& hh::core::CoreQueueSlot::slotMutex ( ) const

inline

Mutex accessor.

Returns: mutex

Definition at line 66 of file core_queue_slot.h.

Here is the caller graph for this function:

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

/home/tjb3/work/hedgehog-nist/hedgehog/core/io/queue/receiver/core_queue_slot.h

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CoreQueueSlot()

Member Function Documentation

◆ addNotifier()

◆ copyInnerStructure()

◆ hasNotifierConnected()

◆ notifiers()

◆ notifyConditionVariable()

◆ numberInputNodes()

◆ removeNotifier()

◆ slotMutex()