stateline::comms::Message Class Reference

Define valid messages to send on the GDFP-SW (GDF Server-Worker Protocol) More...

#include <messages.hpp>

Public Member Functions
	Message (const std::vector< std::string > &addr, const Subject &subj, const std::vector< std::string > &d)
	Constructor to build a message. More...
	Message (const Subject &subj, const std::vector< std::string > &d)
	Create a new message with no address. More...
	Message (const std::vector< std::string > &addr, const Subject &subj)
	Create a new message with no data. More...
	Message (const Subject &subj)
	Constructor to build a message with no data or address. More...
bool	operator== (const Message &m) const
	Equality comparator for testing purposes. More...

Public Attributes
std::vector< std::string >	address
	The destination address of this message.
Subject	subject
	The subject of the message (e.g. HELLO).
std::vector< std::string >	data
	The data that this message contains.

Friends
std::ostream &	operator<< (std::ostream &os, const Message &m)
	Allows a message to be printed with std::cout. More...

Detailed Description

Define valid messages to send on the GDFP-SW (GDF Server-Worker Protocol)

Constructor & Destructor Documentation

stateline::comms::Message::Message	(	const std::vector< std::string > &	addr,
		const Subject &	subj,
		const std::vector< std::string > &	d
	)

Constructor to build a message.

Parameters

addr	The address to send the message to.
subj	The subject of the message (eg. HELLO, JOB etc).
d	A vector of data to send in the message. Each element of the vector is sent as a separate frame.

stateline::comms::Message::Message	(	const Subject &	subj,
		const std::vector< std::string > &	d
	)

Create a new message with no address.

Parameters

subj	The subject of the message (eg. HELLO, JOB etc).
d	A vector of data to send in the message. Each element of the vector is sent as a separate frame.

stateline::comms::Message::Message	(	const std::vector< std::string > &	addr,
		const Subject &	subj
	)

Create a new message with no data.

Parameters

addr	The address to send the message to.
subj	The subject of the message (eg. HELLO, JOB etc).

stateline::comms::Message::Message

(

const Subject &

subj

)

Constructor to build a message with no data or address.

Parameters

subj	The subject of the message (eg. HELLO, JOB etc).

Member Function Documentation

bool stateline::comms::Message::operator==

(

const Message &

m

)

const

Equality comparator for testing purposes.

Parameters

m	The message to compare with.

Returns

True if the message is equal to this message.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const Message &  m  )

friend

Allows a message to be printed with std::cout.

Parameters

os	the output stream.
m	the message object.
os	The output stream.
m	The message to print.

---

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

• /home/lb/code/GDF/src/comms/messages.hpp
• /home/lb/code/GDF/src/comms/messages.cpp