add an object to the input queue of an input port More...

#include <core/messages.h>

Inheritance diagram for vistle::message::AddObject:

Collaboration diagram for vistle::message::AddObject:

[legend]

Public Member Functions
	AddObject (const std::string &senderPort, vistle::Object::const_ptr obj, const std::string &destPort="")

	AddObject (const AddObject &other)

	AddObject (const AddObjectCompleted &complete)

	~AddObject ()

bool	operator< (const AddObject &other) const

void	setSenderPort (const std::string &sendPort)

const char *	getSenderPort () const

void	setDestPort (const std::string &destPort)

const char *	getDestPort () const

const char *	objectName () const

void	setObject (Object::const_ptr obj)

Object::const_ptr	takeObject () const
	may only be called once More...

Object::const_ptr	getObject () const

bool	ref () const
	try to retrieve from shmem by name More...

const Meta &	meta () const

Object::Type	objectType () const

const shm_handle_t &	getHandle () const

bool	handleValid () const

void	setBlocker ()

bool	isBlocker () const

void	setUnblocking ()

bool	isUnblocking () const

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_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

Additional Inherited Members
Static Public Attributes inherited from vistle::message::MessageBase< AddObject, ADDOBJECT >
static const Type	s_type

Static Public Attributes inherited from vistle::message::Message
static const size_t	MESSAGE_SIZE = 1024

Protected Member Functions inherited from vistle::message::MessageBase< AddObject, ADDOBJECT >
	MessageBase ()

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...

Detailed Description

add an object to the input queue of an input port

Constructor & Destructor Documentation

◆ AddObject() [1/3]

vistle::message::AddObject::AddObject	(	const std::string &	senderPort,
		vistle::Object::const_ptr	obj,
		const std::string &	destPort = `""`
	)

◆ AddObject() [2/3]

vistle::message::AddObject::AddObject ( const AddObject & other )

◆ AddObject() [3/3]

vistle::message::AddObject::AddObject ( const AddObjectCompleted & complete )

◆ ~AddObject()

vistle::message::AddObject::~AddObject ( )

default

Member Function Documentation

◆ getDestPort()

const char * vistle::message::AddObject::getDestPort ( ) const

◆ getHandle()

const shm_handle_t & vistle::message::AddObject::getHandle ( ) const

◆ getObject()

Object::const_ptr vistle::message::AddObject::getObject ( ) const

◆ getSenderPort()

const char * vistle::message::AddObject::getSenderPort ( ) const

◆ handleValid()

bool vistle::message::AddObject::handleValid ( ) const

◆ isBlocker()

bool vistle::message::AddObject::isBlocker ( ) const

◆ isUnblocking()

bool vistle::message::AddObject::isUnblocking ( ) const

◆ meta()

const Meta & vistle::message::AddObject::meta ( ) const

◆ objectName()

const char * vistle::message::AddObject::objectName ( ) const

◆ objectType()

Object::Type vistle::message::AddObject::objectType ( ) const

◆ operator<()

bool vistle::message::AddObject::operator< ( const AddObject & other ) const

◆ ref()

bool vistle::message::AddObject::ref ( ) const

try to retrieve from shmem by name

may only be called once

◆ setBlocker()

void vistle::message::AddObject::setBlocker ( )

◆ setDestPort()

void vistle::message::AddObject::setDestPort ( const std::string & destPort )

◆ setObject()

void vistle::message::AddObject::setObject ( Object::const_ptr obj )

◆ setSenderPort()

void vistle::message::AddObject::setSenderPort ( const std::string & sendPort )

◆ setUnblocking()

void vistle::message::AddObject::setUnblocking ( )

◆ takeObject()

Object::const_ptr vistle::message::AddObject::takeObject ( ) const