vistle::message::Message Class Reference

#include <core/message.h>

Inheritance diagram for vistle::message::Message:

Collaboration diagram for vistle::message::Message:

Public Member Functions
	Message (const Type type, const unsigned int size)
unsigned long	typeFlags () const
	processing flags for messages of a type, composed of RoutingFlags More...
void	setUuid (const uuid_t &uuid)
	set message uuid More...
const uuid_t &	uuid () const
	message uuid More...
void	setReferrer (const uuid_t &ref)
	set uuid of message which this message reacts to More...
const uuid_t &	referrer () const
	message this message refers to More...
Type	type () const
	message type More...
int	senderId () const
	sender ID More...
void	setSenderId (int id)
	set sender ID More...
int	rank () const
	sender rank More...
void	setRank (int rank)
	set sender rank More...
int	uiId () const
	UI id, if sent from a UI. More...
size_t	size () const
	message size More...
bool	isForBroadcast () const
	message has to be broadcast to all ranks? More...
void	setForBroadcast (bool enable=true)
	mark message for broadcast to all ranks on destination More...
bool	wasBroadcast () const
	was message broadcast to all ranks? More...
void	setWasBroadcast (bool enable=true)
	mark message as broadcast to all ranks More...
bool	isNotification () const
	message is not a request for action, just a notification that an action has been taken More...
void	setNotify (bool enable)
	mark message as notification More...
int	destId () const
	id of message destination More...
void	setDestId (int id)
	set id of message destination More...
int	destRank () const
	rank of message destination More...
void	setDestRank (int r)
	set rank of destination More...
int	destUiId () const
	id of destination UI More...
void	setDestUiId (int id)
	set id of destination UI More...
size_t	payloadSize () const
	number of additional data bytes following message More...
void	setPayloadSize (size_t size)
	set payload size More...
std::string	payloadName () const
	retrieve name of payload in shared memory More...
void	setPayloadName (const shm_name_t &name)
	set name of payload in shared memory More...
CompressionMode	payloadCompression () const
	compression method for payload More...
void	setPayloadCompression (CompressionMode mode)
	set compression method for payload More...
size_t	payloadRawSize () const
	number of uncompressed payload bytes More...
void	setPayloadRawSize (size_t size)
	set number of uncompressed payload bytes More...
template<class SomeMessage >
SomeMessage &	as ()
template<class SomeMessage >
SomeMessage const &	as () const

Static Public Attributes
static const size_t	MESSAGE_SIZE = 1024

Protected Attributes
uint64_t	m_payloadSize
	payload size More...
uint64_t	m_payloadRawSize
	raw (uncompressed) payload size More...
int	m_payloadCompression
	payload compression method More...
shm_name_t	m_payloadName
	name of payload in shared memory More...
bool	m_forBroadcast
	broadcast to all ranks? More...
bool	m_wasBroadcast
bool	m_notification
	message is not a request for action More...
char	m_pad [1] = {}
	pad message to multiple of 8 bytes More...

Constructor & Destructor Documentation

Message()

vistle::message::Message::Message	(	const Type	type,
		const unsigned int	size
	)

Member Function Documentation

as() [1/2]

template<class SomeMessage >

SomeMessage & vistle::message::Message::as ( )

inline

as() [2/2]

template<class SomeMessage >

SomeMessage const & vistle::message::Message::as ( ) const

inline

destId()

int vistle::message::Message::destId

(

)

const

id of message destination

destRank()

int vistle::message::Message::destRank

(

)

const

rank of message destination

destUiId()

int vistle::message::Message::destUiId

(

)

const

id of destination UI

isForBroadcast()

bool vistle::message::Message::isForBroadcast

(

)

const

message has to be broadcast to all ranks?

isNotification()

bool vistle::message::Message::isNotification

(

)

const

message is not a request for action, just a notification that an action has been taken

payloadCompression()

CompressionMode vistle::message::Message::payloadCompression

(

)

const

compression method for payload

payloadName()

std::string vistle::message::Message::payloadName

(

)

const

retrieve name of payload in shared memory

payloadRawSize()

size_t vistle::message::Message::payloadRawSize

(

)

const

number of uncompressed payload bytes

payloadSize()

size_t vistle::message::Message::payloadSize

(

)

const

number of additional data bytes following message

rank()

int vistle::message::Message::rank

(

)

const

sender rank

referrer()

const uuid_t & vistle::message::Message::referrer

(

)

const

message this message refers to

senderId()

int vistle::message::Message::senderId

(

)

const

sender ID

setDestId()

void vistle::message::Message::setDestId

(

int

id

)

set id of message destination

setDestRank()

void vistle::message::Message::setDestRank

(

int

r

)

set rank of destination

setDestUiId()

void vistle::message::Message::setDestUiId

(

int

id

)

set id of destination UI

setForBroadcast()

void vistle::message::Message::setForBroadcast

(

bool

enable = true

)

mark message for broadcast to all ranks on destination

setNotify()

void vistle::message::Message::setNotify

(

bool

enable

)

mark message as notification

setPayloadCompression()

void vistle::message::Message::setPayloadCompression

(

CompressionMode

mode

)

set compression method for payload

setPayloadName()

void vistle::message::Message::setPayloadName

(

const shm_name_t &

name

)

set name of payload in shared memory

setPayloadRawSize()

void vistle::message::Message::setPayloadRawSize

(

size_t

size

)

set number of uncompressed payload bytes

setPayloadSize()

void vistle::message::Message::setPayloadSize

(

size_t

size

)

set payload size

setRank()

void vistle::message::Message::setRank

(

int

rank

)

set sender rank

setReferrer()

void vistle::message::Message::setReferrer

(

const uuid_t &

ref

)

set uuid of message which this message reacts to

setSenderId()

void vistle::message::Message::setSenderId

(

int

id

)

set sender ID

setUuid()

void vistle::message::Message::setUuid

(

const uuid_t &

uuid

)

set message uuid

setWasBroadcast()

void vistle::message::Message::setWasBroadcast

(

bool

enable = true

)

mark message as broadcast to all ranks

size()

size_t vistle::message::Message::size

(

)

const

message size

type()

Type vistle::message::Message::type

(

)

const

message type

typeFlags()

unsigned long vistle::message::Message::typeFlags

(

)

const

processing flags for messages of a type, composed of RoutingFlags

uiId()

int vistle::message::Message::uiId

(

)

const

UI id, if sent from a UI.

uuid()

const uuid_t & vistle::message::Message::uuid

(

)

const

message uuid

wasBroadcast()

bool vistle::message::Message::wasBroadcast

(

)

const

was message broadcast to all ranks?

Member Data Documentation

m_forBroadcast

bool vistle::message::Message::m_forBroadcast

protected

broadcast to all ranks?

m_notification

bool vistle::message::Message::m_notification

protected

message is not a request for action

m_pad

char vistle::message::Message::m_pad[1] = {}

protected

pad message to multiple of 8 bytes

m_payloadCompression

int vistle::message::Message::m_payloadCompression

protected

payload compression method

m_payloadName

shm_name_t vistle::message::Message::m_payloadName

protected

name of payload in shared memory

m_payloadRawSize

uint64_t vistle::message::Message::m_payloadRawSize

protected

raw (uncompressed) payload size

m_payloadSize

uint64_t vistle::message::Message::m_payloadSize

protected

payload size

m_wasBroadcast

bool vistle::message::Message::m_wasBroadcast

protected

MESSAGE_SIZE

const size_t vistle::message::Message::MESSAGE_SIZE = 1024

static

---

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

• core/message.h
• core/message.cpp