MessageHolder Class Reference
[Converse Communication Optimization Framework]

An abstract data structure that holds a converse message and which can be buffered by the communication library Message holder is a wrapper around a message. More...

#include <convcomlibstrategy.h>

Inheritance diagram for MessageHolder:

[legend]

Collaboration diagram for MessageHolder:

[legend]

Public Member Functions
	MessageHolder ()
	MessageHolder (CkMigrateMessage *m)
	MessageHolder (char *msg, int sz, int proc)
	Single destination constructor.
	MessageHolder (char *msg, int sz)
	Broadcast constructor.
	MessageHolder (char *msg, int sz, int np, int *pes)
	Multicast constructor.
	~MessageHolder ()
char *	getMessage ()
int	getSize ()
void *	operator new (size_t size)
void	operator delete (void *buf)
virtual void	pup (PUP::er &p)
	PUPable_decl (MessageHolder)
Data Fields
char *	data
int	size
int	isDummy
int	npes
	npes=0 means broadcast, npes=1 means one destination specified by dest_proc, npes>1 means multicast with destinations specified in the array pelist
union {
int *   pelist
int   dest_proc
};

---

Detailed Description

An abstract data structure that holds a converse message and which can be buffered by the communication library Message holder is a wrapper around a message.

Has other useful data like destination processor list for a multicast etc.

Definition at line 87 of file convcomlibstrategy.h.

---

Constructor & Destructor Documentation

MessageHolder::MessageHolder

(

)

[inline]

Definition at line 105 of file convcomlibstrategy.h.

References data, dest_proc, isDummy, and size.

MessageHolder::MessageHolder

(

CkMigrateMessage *

m

)

[inline]

Definition at line 108 of file convcomlibstrategy.h.

MessageHolder::MessageHolder	(	char *	msg,
		int	sz,
		int	proc
	)			[inline]

Single destination constructor.

Definition at line 111 of file convcomlibstrategy.h.

References data, dest_proc, isDummy, npes, and size.

MessageHolder::MessageHolder	(	char *	msg,
		int	sz
	)			[inline]

Broadcast constructor.

Definition at line 122 of file convcomlibstrategy.h.

References data, dest_proc, isDummy, npes, and size.

MessageHolder::MessageHolder	(	char *	msg,
		int	sz,
		int	np,
		int *	pes
	)			[inline]

Multicast constructor.

Definition at line 133 of file convcomlibstrategy.h.

References data, isDummy, npes, pelist, and size.

MessageHolder::~MessageHolder

(

)

[inline]

Definition at line 143 of file convcomlibstrategy.h.

---

Member Function Documentation

char* MessageHolder::getMessage

(

void

)

[inline]

Definition at line 150 of file convcomlibstrategy.h.

References data.

Referenced by Router::EachToManyMulticastQ(), HypercubeRouter::EachToManyMulticastQ(), GridRouter::EachToManyMulticastQ(), DimexRouter::EachToManyMulticastQ(), RouterStrategy::insertMessage(), PipeBroadcastConverse::insertMessage(), PrefixRouter::sendMulticast(), and PrefixRouter::sendPointToPoint().

int MessageHolder::getSize

(

void

)

[inline]

Definition at line 154 of file convcomlibstrategy.h.

References size.

Referenced by PipeBroadcastConverse::insertMessage(), PrioStreaming::insertMessage(), and ChunkMulticastStrategy::insertMessage().

void* MessageHolder::operator new

(

size_t

size

)

[inline]

Definition at line 158 of file convcomlibstrategy.h.

References CmiAlloc().

void MessageHolder::operator delete

(

void *

buf

)

[inline]

Definition at line 162 of file convcomlibstrategy.h.

References CmiFree().

MessageHolder::PUPable_decl

(

MessageHolder

)

---

Field Documentation

char* MessageHolder::data

Definition at line 89 of file convcomlibstrategy.h.

Referenced by CharmMessageHolder::getCharmMessage(), getMessage(), ChunkMulticastStrategy::insertMessage(), MessageHolder(), and pup().

int MessageHolder::size

Definition at line 90 of file convcomlibstrategy.h.

Referenced by Router::EachToManyMulticastQ(), HypercubeRouter::EachToManyMulticastQ(), GridRouter::EachToManyMulticastQ(), DimexRouter::EachToManyMulticastQ(), getSize(), RouterStrategy::insertMessage(), ChunkMulticastStrategy::insertMessage(), MessageHolder(), pup(), PrefixRouter::sendMulticast(), and PrefixRouter::sendPointToPoint().

int MessageHolder::isDummy

Definition at line 91 of file convcomlibstrategy.h.

Referenced by RouterStrategy::doneInserting(), MessageHolder(), and pup().

int MessageHolder::npes

npes=0 means broadcast, npes=1 means one destination specified by dest_proc, npes>1 means multicast with destinations specified in the array pelist

Definition at line 99 of file convcomlibstrategy.h.

Referenced by ComlibManager::ArrayBroadcast(), ComlibManager::ArraySectionSend(), RouterStrategy::doneInserting(), Router::EachToManyMulticastQ(), HypercubeRouter::EachToManyMulticastQ(), GridRouter::EachToManyMulticastQ(), DimexRouter::EachToManyMulticastQ(), ComlibManager::GroupBroadcast(), RouterStrategy::insertMessage(), EachToManyMulticastStrategy::insertMessage(), MessageHolder(), and pup().

int* MessageHolder::pelist

Definition at line 101 of file convcomlibstrategy.h.

Referenced by RouterStrategy::doneInserting(), Router::EachToManyMulticastQ(), HypercubeRouter::EachToManyMulticastQ(), GridRouter::EachToManyMulticastQ(), DimexRouter::EachToManyMulticastQ(), RouterStrategy::insertMessage(), EachToManyMulticastStrategy::insertMessage(), MessageHolder(), and pup().

int MessageHolder::dest_proc

Definition at line 102 of file convcomlibstrategy.h.

Referenced by PrefixRouter::EachToManyMulticastQ(), RouterStrategy::insertMessage(), RectMulticastStrategy::insertMessage(), PrioStreaming::insertMessage(), OneTimeMulticastStrategy::insertMessage(), MulticastStrategy::insertMessage(), EachToManyMulticastStrategy::insertMessage(), ChunkMulticastStrategy::insertMessage(), MessageHolder(), pup(), rewritePEs(), PrefixRouter::sendMulticast(), and PrefixRouter::sendPointToPoint().

union { ... }

---

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

• conv-com/convcomlibstrategy.h
• conv-com/convcomlibstrategy.C