View on GitHub

Vistle

Distributed Data-parallel Scientific Visualization in VR

Static Public Attributes | Protected Member Functions | List of all members
vistle::message::MessageBase< MessageClass, MessageType > Class Template Reference

#include <core/message.h>

Inheritance diagram for vistle::message::MessageBase< MessageClass, MessageType >:
Inheritance graph
[legend]
Collaboration diagram for vistle::message::MessageBase< MessageClass, MessageType >:
Collaboration graph
[legend]

Static Public Attributes

static const Type s_type = MessageType
 
- Static Public Attributes inherited from vistle::message::Message
static const size_t MESSAGE_SIZE = 1024
 

Protected Member Functions

 MessageBase ()
 

Additional Inherited Members

- Public Member Functions inherited from vistle::message::Message
 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_tuuid () const
 message uuid More...
 
void setReferrer (const uuid_t &ref)
 set uuid of message which this message reacts to More...
 
const uuid_treferrer () 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
 
- Protected Attributes inherited from vistle::message::Message
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

◆ MessageBase()

template<class MessageClass , Type MessageType>
vistle::message::MessageBase< MessageClass, MessageType >::MessageBase ( )
inlineprotected

Member Data Documentation

◆ s_type

template<class MessageClass , Type MessageType>
const Type vistle::message::MessageBase< MessageClass, MessageType >::s_type = MessageType
static

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