Class for message queue element. More...

#include <paraCommCPP11.h>

Public Member Functions
	MessageQueueElement ()
	default constructor of MessageQueueElement More...

	MessageQueueElement (int inSource, int inCount, int inDataTypeId, int inTag, void *inData)
	constructor of MessageQueueElement More...

	~MessageQueueElement ()
	destructor of MessageQueueElement More...

int	getSource ()
	getter of source rank More...

int	getCount ()
	getter of the number of the data type elements More...

int	getDataTypeId ()
	getter of the data type id More...

int	getTag ()
	getter of the message tag More...

void *	getData ()
	getter of data More...

MessageQueueElement *	getNext ()
	getter of the pointer to the next MessageQueueElement More...

void	link (MessageQueueElement *nextElement)
	link to the next MessageQueueElement More...

	MessageQueueElement ()
	default constructor of MessageQueueElement More...

	MessageQueueElement (int inSource, int inCount, int inDataTypeId, int inTag, void *inData)
	constructor of MessageQueueElement More...

	~MessageQueueElement ()
	destructor of MessageQueueElement More...

int	getSource ()
	getter of source rank More...

int	getCount ()
	getter of the number of the data type elements More...

int	getDataTypeId ()
	getter of the data type id More...

int	getTag ()
	getter of the message tag More...

void *	getData ()
	getter of data More...

MessageQueueElement *	getNext ()
	getter of the pointer to the next MessageQueueElement More...

void	link (MessageQueueElement *nextElement)
	link to the next MessageQueueElement More...

Private Attributes
int	source
	source thread rank of this message More...

int	count
	number of the data type elements More...

int	dataTypeId
	data type id More...

int	tag
	tag of the message, -1 : in case of broadcast message More...

void *	data
	data of the message More...

MessageQueueElement *	next
	point to next message queue element More...

Detailed Description

Class for message queue element.

NOTE : For basic data types, this is copy of sender side memory. When the memory is copied at receive function, the memory have to be freed. For user defined data type, this is the receiver side memory, because it is better to allocate memory in the sender side for mutex locking. Sender side functions have to allocate memory. In this case, memory do not have to be freed. The memory is for receiver side.

Definition at line 122 of file paraCommCPP11.h.

Constructor & Destructor Documentation

◆ MessageQueueElement() [1/4]

MessageQueueElement ( )

default constructor of MessageQueueElement

Definition at line 137 of file paraCommCPP11.h.

◆ MessageQueueElement() [2/4]

MessageQueueElement	(	int	inSource,
		int	inCount,
		int	inDataTypeId,
		int	inTag,
		void *	inData
	)

constructor of MessageQueueElement

Parameters

inSource	source thread rank of this message
inCount	number of the data type elements
inDataTypeId	data type id
inTag	tag of the message, -1 : in case of broadcast message
inData	data of the message

Definition at line 151 of file paraCommCPP11.h.

◆ ~MessageQueueElement() [1/2]

~MessageQueueElement ( )

destructor of MessageQueueElement

Definition at line 164 of file paraCommCPP11.h.

◆ MessageQueueElement() [3/4]

MessageQueueElement ( )

default constructor of MessageQueueElement

Definition at line 130 of file paraCommPth.h.

◆ MessageQueueElement() [4/4]

MessageQueueElement	(	int	inSource,
		int	inCount,
		int	inDataTypeId,
		int	inTag,
		void *	inData
	)

constructor of MessageQueueElement

Parameters

inSource	source thread rank of this message
inCount	number of the data type elements
inDataTypeId	data type id
inTag	tag of the message, -1 : in case of broadcast message
inData	data of the message

Definition at line 138 of file paraCommPth.h.

◆ ~MessageQueueElement() [2/2]

~MessageQueueElement ( )

destructor of MessageQueueElement

Definition at line 151 of file paraCommPth.h.

Member Function Documentation

◆ getCount() [1/2]

int getCount ( )

getter of the number of the data type elements

Returns: the number of the data type elements

Definition at line 183 of file paraCommCPP11.h.

References MessageQueueElement::count.

Referenced by ParaCommCPP11::freeStandardTypes(), and ParaCommPth::freeStandardTypes().

◆ getCount() [2/2]

int getCount ( )

getter of the number of the data type elements

Returns: the number of the data type elements

Definition at line 170 of file paraCommPth.h.

References MessageQueueElement::count.

◆ getData() [1/2]

void * getData ( )

getter of data

Returns: pointer to the data

Definition at line 213 of file paraCommCPP11.h.

References MessageQueueElement::data.

Referenced by ParaCommCPP11::freeStandardTypes(), ParaCommPth::freeStandardTypes(), ParaCommCPP11::receive(), ParaCommPth::receive(), ParaCommCPP11::uTypeReceive(), ParaCommPth::uTypeReceive(), ParaCommCPP11::~ParaCommCPP11(), ParaCommPth::~ParaCommPth(), and ScipParaCommTh::~ScipParaCommTh().

◆ getData() [2/2]

void * getData ( )

getter of data

Returns: pointer to the data

Definition at line 200 of file paraCommPth.h.

References MessageQueueElement::data.

◆ getDataTypeId() [1/2]

int getDataTypeId ( )

getter of the data type id

Returns: data type id

Definition at line 193 of file paraCommCPP11.h.

References MessageQueueElement::dataTypeId.

Referenced by MessageQueueTableElement::extarctElement(), ParaCommCPP11::freeStandardTypes(), ParaCommPth::freeStandardTypes(), MessageQueueTableElement::waitMessage(), ParaCommCPP11::~ParaCommCPP11(), ParaCommPth::~ParaCommPth(), and ScipParaCommTh::~ScipParaCommTh().

◆ getDataTypeId() [2/2]

int getDataTypeId ( )

getter of the data type id

Returns: data type id

Definition at line 180 of file paraCommPth.h.

References MessageQueueElement::dataTypeId.

◆ getNext() [1/2]

MessageQueueElement * getNext ( )

getter of the pointer to the next MessageQueueElement

Returns: pointer to MessageQueueElement

Definition at line 223 of file paraCommCPP11.h.

References MessageQueueElement::next.

Referenced by MessageQueueTableElement::checkElement(), MessageQueueTableElement::checkElementWithTag(), MessageQueueTableElement::extarctElement(), MessageQueueTableElement::waitMessage(), and MessageQueueTableElement::~MessageQueueTableElement().

◆ getNext() [2/2]

MessageQueueElement * getNext ( )

getter of the pointer to the next MessageQueueElement

Returns: pointer to MessageQueueElement

Definition at line 210 of file paraCommPth.h.

References MessageQueueElement::next.

◆ getSource() [1/2]

int getSource ( )

getter of source rank

Returns: rank of the source

Definition at line 173 of file paraCommCPP11.h.

References MessageQueueElement::source.

Referenced by MessageQueueTableElement::extarctElement(), ParaCommCPP11::iProbe(), ParaCommPth::iProbe(), ParaCommCPP11::probe(), ParaCommPth::probe(), and MessageQueueTableElement::waitMessage().

◆ getSource() [2/2]

int getSource ( )

getter of source rank

Returns: rank of the source

Definition at line 160 of file paraCommPth.h.

References MessageQueueElement::source.

◆ getTag() [1/2]

int getTag ( )

getter of the message tag

Returns: tag of the message

Definition at line 203 of file paraCommCPP11.h.

References MessageQueueElement::tag.

Referenced by MessageQueueTableElement::extarctElement(), ParaCommCPP11::iProbe(), ParaCommPth::iProbe(), ParaCommCPP11::probe(), ParaCommPth::probe(), and MessageQueueTableElement::waitMessage().

◆ getTag() [2/2]

int getTag ( )

getter of the message tag

Returns: tag of the message

Definition at line 190 of file paraCommPth.h.

References MessageQueueElement::tag.

◆ link() [1/2]

void link ( MessageQueueElement * nextElement )

link to the next MessageQueueElement

Parameters

nextElement pointer to MessageQueueElement

Definition at line 232 of file paraCommCPP11.h.

References MessageQueueElement::next.

Referenced by MessageQueueTableElement::enqueue(), and MessageQueueTableElement::extarctElement().

◆ link() [2/2]

void link ( MessageQueueElement * nextElement )

link to the next MessageQueueElement

Parameters

nextElement pointer to MessageQueueElement

Definition at line 219 of file paraCommPth.h.

References MessageQueueElement::next.

Member Data Documentation

◆ count

int count

private

number of the data type elements

number of elements of the data type

Definition at line 126 of file paraCommCPP11.h.

Referenced by MessageQueueElement::getCount().

◆ data

void * data

private

data of the message

NOTE : For basic data types, this is copy of sender side memory. When the memory is copied at receive function, the memory have to be freed. For user defined data type, this is the receiver side memory, because it is better to allocate memory in the sender side for mutex locking. Sender side functions have to allocate memory. In this case, memory do not hvae to freed. The memory is for receiver side.

Definition at line 129 of file paraCommCPP11.h.

Referenced by MessageQueueElement::getData().

◆ dataTypeId

int dataTypeId

private

data type id

Definition at line 127 of file paraCommCPP11.h.

Referenced by MessageQueueElement::getDataTypeId().

◆ next

MessageQueueElement * next

private

point to next message queue element

Definition at line 130 of file paraCommCPP11.h.

Referenced by MessageQueueElement::getNext(), and MessageQueueElement::link().

◆ source

int source

private

source thread rank of this message

Definition at line 125 of file paraCommCPP11.h.

Referenced by MessageQueueElement::getSource().

◆ tag

int tag

private

tag of the message, -1 : in case of broadcast message

-1 : in case of broadcast message

Definition at line 128 of file paraCommCPP11.h.

Referenced by MessageQueueElement::getTag().

UG

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MessageQueueElement() [1/4]

◆ MessageQueueElement() [2/4]

◆ ~MessageQueueElement() [1/2]

◆ MessageQueueElement() [3/4]

◆ MessageQueueElement() [4/4]

◆ ~MessageQueueElement() [2/2]

Member Function Documentation

◆ getCount() [1/2]

◆ getCount() [2/2]

◆ getData() [1/2]

◆ getData() [2/2]

◆ getDataTypeId() [1/2]

◆ getDataTypeId() [2/2]

◆ getNext() [1/2]

◆ getNext() [2/2]

◆ getSource() [1/2]

◆ getSource() [2/2]

◆ getTag() [1/2]

◆ getTag() [2/2]

◆ link() [1/2]

◆ link() [2/2]

Member Data Documentation

◆ count

◆ data

◆ dataTypeId

◆ next

◆ source

◆ tag