vistle::message Namespace Reference

Classes
class	AddHub
	announce that a (slave) hub has connected More...
class	AddObject
	add an object to the input queue of an input port More...
class	AddObjectCompleted
class	AddParameter
	notification that a module has created a parameter More...
class	AddPort
	notification that a module has created an input/output port More...
class	Barrier
class	BarrierReached
class	Buffer
class	Busy
	indicate that a module has started computing More...
class	CancelExecute
	trigger execution of a module function More...
class	CloseConnection
	terminate a socket connection More...
class	codec_error
class	Connect
	connect an output port to an input port of another module More...
class	Cover
	wrap a COVISE message sent by COVER More...
class	CreateModuleCompound
class	DataTransferState
class	Debug
	request a module to quit More...
class	DefaultSender
class	Disconnect
	disconnect an output port from an input port of another module More...
class	Execute
	trigger execution of a module function More...
class	ExecutionProgress
	steer execution stages More...
class	FileQuery
class	FileQueryResult
class	Identify
	indicate the kind of a communication partner More...
class	Idle
	indicate that a module has finished computing More...
class	Kill
	request a module to quit More...
class	LockUi
	lock UI (block user interaction) More...
class	Message
class	MessageBase
class	MessageFactory
class	MessageQueue
class	ModuleAvailable
	announce availability of a module to UI More...
struct	ModuleBaseMessage
class	ModuleExit
	notify that a module has quit More...
class	ObjectReceivePolicy
	control where AddObject messages are sent More...
class	Ping
	debug: request a reply containing character 'c' More...
class	Pong
	debug: reply to pong More...
class	Quit
	request all modules to quit for terminating the session More...
class	ReducePolicy
	control whether/when prepare() and reduce() are called More...
class	RemoveHub
	request that a slave hub be deleted More...
class	RemoveParameter
	notification that a module has removed a parameter More...
class	RemovePort
	notification that a module has destroyed an input/output port More...
class	ReplayFinished
class	RequestObject
	request remote data object More...
class	RequestTunnel
	request hub to listen on TCP port and forward incoming connections More...
class	Router
class	SchedulingPolicy
class	SendObject
	header for data object transmission More...
class	SendText
	send text messages to user interfaces More...
class	SetId
class	SetParameter
	request parameter value update or notify that a parameter value has been changed More...
class	SetParameterChoices
	set list of choice descriptions for a choice parameter More...
class	Spawn
	spawn a module More...
class	SpawnPrepared
	notification of manager that spawning is possible (i.e. shmem has been set up) More...
class	Started
	acknowledge that a module has been spawned More...
class	Trace
	enable/disable message tracing for a module More...
class	UpdateStatus
	update status of a module (or other entity) More...

Typedefs
typedef std::array< char, ModuleNameLength >	module_name_t
typedef std::array< char, 32 >	port_name_t
typedef std::array< char, 32 >	param_name_t
typedef std::array< char, 256 >	param_value_t
typedef std::array< char, 50 >	param_choice_t
typedef std::array< char, 300 >	shmsegname_t
typedef std::array< char, 350 >	description_t
typedef std::array< char, 200 >	address_t
typedef std::array< char, 500 >	path_t
typedef boost::uuids::uuid	uuid_t
typedef uint32_t	SizeType
typedef boost::asio::ip::tcp::socket	socket_t

Enumerations
enum	RoutingFlags {   Track = 0x000001 , NodeLocal = 0x000002 , ClusterLocal = 0x000004 , DestMasterHub = 0x000008 ,   DestSlaveHub = 0x000010 , DestLocalHub = 0x000020 , DestHub = DestMasterHub | DestSlaveHub , DestUi = 0x000040 ,   DestModules = 0x000080 , DestMasterManager = 0x000100 , DestSlaveManager = 0x000200 , DestLocalManager = 0x000400 ,   DestManager = DestSlaveManager | DestMasterManager , Special = 0x000800 , RequiresSubscription = 0x001000 , Broadcast = 0x100000 ,   BroadcastModule = Broadcast | DestModules , HandleOnNode = 0x002000 , HandleOnRank0 = 0x004000 , HandleOnHub = 0x008000 ,   HandleOnMaster = 0x010000 , HandleOnDest = 0x020000 , QueueIfUnhandled = 0x040000 , TriggerQueue = 0x080000 ,   CleanQueue = 0x100000 , OnlyRank0 = 0x200000 }

Functions
buffer	compressPayload (CompressionMode &mode, const buffer &raw, int speed)
buffer	compressPayload (CompressionMode &mode, const char *raw, size_t size, int speed)
buffer	compressPayload (CompressionMode mode, Message &msg, buffer &raw, int speed)
buffer	decompressPayload (CompressionMode mode, size_t size, size_t rawsize, buffer &compressed)
buffer	decompressPayload (CompressionMode mode, size_t size, size_t rawsize, const char *compressed)
buffer	decompressPayload (const Message &msg, buffer &compressed)
	DEFINE_ENUM_WITH_STRING_CONVERSIONS (CompressionMode,(CompressionNone)(CompressionLz4)(CompressionZstd)(CompressionSnappy)) DEFINE_ENUM_WITH_STRING_CONVERSIONS(Type
	INVALID (ANY)(IDENTIFY)(CLOSECONNECTION)(ADDHUB)(REMOVEHUB)(SETID)(TRACE)(SPAWN)(SPAWNPREPARED)(KILL)(DEBUG)(QUIT)(STARTED)(MODULEEXIT)(BUSY)(IDLE)(EXECUTIONPROGRESS)(EXECUTE)(CANCELEXECUTE)(ADDOBJECT)(ADDOBJECTCOMPLETED)(DATATRANSFERSTATE)(ADDPORT)(REMOVEPORT)(CONNECT)(DISCONNECT)(ADDPARAMETER)(REMOVEPARAMETER)(SETPARAMETER)(SETPARAMETERCHOICES)(PING)(PONG)(BARRIER)(BARRIERREACHED)(SENDTEXT)(UPDATESTATUS)(OBJECTRECEIVEPOLICY)(SCHEDULINGPOLICY)(REDUCEPOLICY)(MODULEAVAILABLE)(CREATEMODULECOMPOUND)(LOCKUI)(REPLAYFINISHED)(REQUESTTUNNEL)(REQUESTOBJECT)(SENDOBJECT)(REMOTERENDERING)(FILEQUERY)(FILEQUERYRESULT)(COVER)(INSITU)(NumMessageTypes)) struct V_COREEXPORT Id
V_COREEXPORT buffer	compressPayload (vistle::message::CompressionMode &mode, const char *raw, size_t size, int speed=-1)
V_COREEXPORT buffer	compressPayload (vistle::message::CompressionMode &mode, const buffer &raw, int speed=-1)
V_COREEXPORT buffer	compressPayload (vistle::message::CompressionMode mode, Message &msg, buffer &raw, int speed=-1)
V_COREEXPORT buffer	decompressPayload (vistle::message::CompressionMode mode, size_t size, size_t rawsize, buffer &compressed)
V_COREEXPORT std::ostream &	operator<< (std::ostream &s, const Message &msg)
template<class Payload >
buffer	addPayload (Message &message, const Payload &payload)
template<class Payload >
void	getFromPayload (const buffer &data, Payload &payload)
template<class Payload >
Payload	getPayload (const buffer &data)
template<typename T >
static T	min (T a, T b)
template V_COREEXPORT buffer	addPayload< std::string > (Message &message, const std::string &payload)
template V_COREEXPORT buffer	addPayload< SendText::Payload > (Message &message, const SendText::Payload &payload)
template V_COREEXPORT buffer	addPayload< SetParameterChoices::Payload > (Message &message, const SetParameterChoices::Payload &payload)
template<class Payload >
V_COREEXPORT buffer	addPayload (Message &message, const Payload &payload)
template<class Payload >
V_COREEXPORT Payload	getPayload (const buffer &data)
void	return_buffer (std::shared_ptr< buffer > &buf)
std::shared_ptr< buffer >	get_buffer (size_t size)
bool	recv_payload (socket_t &sock, message::Buffer &msg, error_code &ec, buffer *payload)
bool	recv_message (socket_t &sock, message::Buffer &msg, error_code &ec, bool block)
bool	recv (socket_t &sock, message::Buffer &msg, error_code &ec, bool block, buffer *payload)
void	async_recv (socket_t &sock, message::Buffer &msg, std::function< void(boost::system::error_code ec, std::shared_ptr< buffer >)> handler)
void	async_recv_header (socket_t &sock, message::Buffer &msg, std::function< void(boost::system::error_code ec)> handler)
bool	send (socket_t &sock, const message::Message &msg, error_code &ec, const char *payload, size_t size)
bool	send (socket_t &sock, const message::Message &msg, error_code &ec, const buffer *payload)
bool	send (socket_t &sock, const Message &msg, const buffer *payload)
void	async_send (socket_t &sock, const message::Message &msg, std::shared_ptr< buffer > payload, const std::function< void(error_code ec)> handler)
void	async_send (socket_t &sock, const message::Message &msg, const MessagePayload &payload, const std::function< void(error_code ec)> handler)
void	async_forward (socket_t &sock, const message::Message &msg, std::shared_ptr< socket_t > payloadSock, const std::function< void(error_code ec)> handler)
void V_COREEXPORT	async_recv (socket_t &sock, vistle::message::Buffer &msg, std::function< void(error_code, std::shared_ptr< buffer >)> handler)
void V_COREEXPORT	async_recv_header (socket_t &sock, vistle::message::Buffer &msg, std::function< void(error_code)> handler)

Variables
static boost::uuids::random_generator	s_uuidGenerator
const int	ModuleNameLength = 50
static const size_t	buffersize = 16384

Typedef Documentation

address_t

typedef std::array<char, 200> vistle::message::address_t

description_t

typedef std::array<char, 350> vistle::message::description_t

module_name_t

typedef std::array<char, ModuleNameLength> vistle::message::module_name_t

param_choice_t

typedef std::array<char, 50> vistle::message::param_choice_t

param_name_t

typedef std::array<char, 32> vistle::message::param_name_t

param_value_t

typedef std::array<char, 256> vistle::message::param_value_t

path_t

typedef std::array<char, 500> vistle::message::path_t

port_name_t

typedef std::array<char, 32> vistle::message::port_name_t

shmsegname_t

typedef std::array<char, 300> vistle::message::shmsegname_t

SizeType

typedef uint32_t vistle::message::SizeType

socket_t

typedef boost::asio::ip::tcp::socket vistle::message::socket_t

uuid_t

typedef boost::uuids::uuid vistle::message::uuid_t

Enumeration Type Documentation

RoutingFlags

enum vistle::message::RoutingFlags

Enumerator
Track
NodeLocal
ClusterLocal
DestMasterHub
DestSlaveHub
DestLocalHub
DestHub
DestUi
DestModules
DestMasterManager
DestSlaveManager
DestLocalManager
DestManager
Special
RequiresSubscription
Broadcast
BroadcastModule
HandleOnNode
HandleOnRank0
HandleOnHub
HandleOnMaster
HandleOnDest
QueueIfUnhandled
TriggerQueue
CleanQueue
OnlyRank0

Function Documentation

addPayload() [1/2]

template<class Payload >

buffer vistle::message::addPayload	(	Message &	message,
		const Payload &	payload
	)

addPayload() [2/2]

template<class Payload >

V_COREEXPORT buffer vistle::message::addPayload	(	Message &	message,
		const Payload &	payload
	)

addPayload< SendText::Payload >()

template V_COREEXPORT buffer vistle::message::addPayload< SendText::Payload >	(	Message &	message,
		const SendText::Payload &	payload
	)

addPayload< SetParameterChoices::Payload >()

template V_COREEXPORT buffer vistle::message::addPayload< SetParameterChoices::Payload >	(	Message &	message,
		const SetParameterChoices::Payload &	payload
	)

addPayload< std::string >()

template V_COREEXPORT buffer vistle::message::addPayload< std::string >	(	Message &	message,
		const std::string &	payload
	)

async_forward()

void V_COREEXPORT vistle::message::async_forward	(	socket_t &	sock,
		const message::Message &	msg,
		std::shared_ptr< socket_t >	payloadSock,
		const std::function< void(error_code ec)>	handler
	)

async_recv() [1/2]

void vistle::message::async_recv	(	socket_t &	sock,
		message::Buffer &	msg,
		std::function< void(boost::system::error_code ec, std::shared_ptr< buffer >)>	handler
	)

async_recv() [2/2]

void V_COREEXPORT vistle::message::async_recv	(	socket_t &	sock,
		vistle::message::Buffer &	msg,
		std::function< void(error_code, std::shared_ptr< buffer >)>	handler
	)

async_recv_header() [1/2]

void vistle::message::async_recv_header	(	socket_t &	sock,
		message::Buffer &	msg,
		std::function< void(boost::system::error_code ec)>	handler
	)

async_recv_header() [2/2]

void V_COREEXPORT vistle::message::async_recv_header	(	socket_t &	sock,
		vistle::message::Buffer &	msg,
		std::function< void(error_code)>	handler
	)

async_send() [1/2]

void V_COREEXPORT vistle::message::async_send	(	socket_t &	sock,
		const message::Message &	msg,
		const MessagePayload &	payload,
		const std::function< void(error_code ec)>	handler
	)

async_send() [2/2]

void V_COREEXPORT vistle::message::async_send	(	socket_t &	sock,
		const message::Message &	msg,
		std::shared_ptr< buffer >	payload,
		const std::function< void(error_code ec)>	handler
	)

compressPayload() [1/6]

buffer vistle::message::compressPayload	(	CompressionMode &	mode,
		const buffer &	raw,
		int	speed
	)

compressPayload() [2/6]

buffer vistle::message::compressPayload	(	CompressionMode &	mode,
		const char *	raw,
		size_t	size,
		int	speed
	)

compressPayload() [3/6]

buffer vistle::message::compressPayload	(	CompressionMode	mode,
		Message &	msg,
		buffer &	raw,
		int	speed
	)

compressPayload() [4/6]

V_COREEXPORT buffer vistle::message::compressPayload	(	vistle::message::CompressionMode &	mode,
		const buffer &	raw,
		int	speed = -1
	)

compressPayload() [5/6]

V_COREEXPORT buffer vistle::message::compressPayload	(	vistle::message::CompressionMode &	mode,
		const char *	raw,
		size_t	size,
		int	speed = -1
	)

compressPayload() [6/6]

V_COREEXPORT buffer vistle::message::compressPayload	(	vistle::message::CompressionMode	mode,
		Message &	msg,
		buffer &	raw,
		int	speed = -1
	)

decompressPayload() [1/4]

buffer vistle::message::decompressPayload	(	CompressionMode	mode,
		size_t	size,
		size_t	rawsize,
		buffer &	compressed
	)

decompressPayload() [2/4]

V_COREEXPORT buffer vistle::message::decompressPayload	(	CompressionMode	mode,
		size_t	size,
		size_t	rawsize,
		const char *	compressed
	)

decompressPayload() [3/4]

V_COREEXPORT buffer vistle::message::decompressPayload	(	const Message &	msg,
		buffer &	compressed
	)

decompressPayload() [4/4]

V_COREEXPORT buffer vistle::message::decompressPayload	(	vistle::message::CompressionMode	mode,
		size_t	size,
		size_t	rawsize,
		buffer &	compressed
	)

DEFINE_ENUM_WITH_STRING_CONVERSIONS()

vistle::message::DEFINE_ENUM_WITH_STRING_CONVERSIONS	(	CompressionMode	,
		(CompressionNone)(CompressionLz4)(CompressionZstd)(CompressionSnappy)
	)

get_buffer()

std::shared_ptr< buffer > V_COREEXPORT vistle::message::get_buffer

(

size_t

size

)

getFromPayload()

template<class Payload >

void vistle::message::getFromPayload	(	const buffer &	data,
		Payload &	payload
	)

getPayload() [1/2]

template<class Payload >

template V_COREEXPORT SetParameterChoices::Payload vistle::message::getPayload

(

const buffer &

data

)

getPayload() [2/2]

template<class Payload >

V_COREEXPORT Payload vistle::message::getPayload

(

const buffer &

data

)

INVALID()

vistle::message::INVALID

(

ANY

)

min()

template<typename T >

static T vistle::message::min ( T  a, T  b  )

static

operator<<()

V_COREEXPORT std::ostream & vistle::message::operator<<	(	std::ostream &	s,
		const Message &	msg
	)

recv()

bool V_COREEXPORT vistle::message::recv	(	socket_t &	sock,
		message::Buffer &	msg,
		error_code &	ec,
		bool	block,
		buffer *	payload
	)

recv_message()

bool V_COREEXPORT vistle::message::recv_message	(	socket_t &	sock,
		message::Buffer &	msg,
		error_code &	ec,
		bool	block
	)

recv_payload()

bool vistle::message::recv_payload	(	socket_t &	sock,
		message::Buffer &	msg,
		error_code &	ec,
		buffer *	payload
	)

return_buffer()

void V_COREEXPORT vistle::message::return_buffer

(

std::shared_ptr< buffer > &

buf

)

send() [1/3]

bool V_COREEXPORT vistle::message::send	(	socket_t &	sock,
		const Message &	msg,
		const buffer *	payload
	)

send() [2/3]

bool V_COREEXPORT vistle::message::send	(	socket_t &	sock,
		const message::Message &	msg,
		error_code &	ec,
		const buffer *	payload
	)

send() [3/3]

bool V_COREEXPORT vistle::message::send	(	socket_t &	sock,
		const message::Message &	msg,
		error_code &	ec,
		const char *	payload,
		size_t	size
	)

Variable Documentation

buffersize

const size_t vistle::message::buffersize = 16384

static

ModuleNameLength

const int vistle::message::ModuleNameLength = 50

s_uuidGenerator

boost::uuids::random_generator vistle::message::s_uuidGenerator

static