sesstype::MsgSig Class Reference

Message Signature. More...

#include <msg.h>

Inheritance diagram for sesstype::MsgSig:

Collaboration diagram for sesstype::MsgSig:

List of all members.

Public Types
typedef std::vector< MsgPayload * >	PayloadContainer
Public Member Functions
	MsgSig (std::string label)
	MsgSig constructor.
	MsgSig (const MsgSig &msgsig)
	MsgSig copy constructor.
virtual	~MsgSig ()
	MsgSig destructor.
virtual MsgSig *	clone () const override
	Make a MsgSig* clone.
std::string	label () const
void	add_payload (MsgPayload *payload)
	Add a payload parameter to current MsgSig.
unsigned int	num_payloads () const
bool	has_payload (std::string name) const
MsgPayload *	payload (unsigned int idx) const
MsgPayload *	payload (std::string name) const
PayloadContainer::const_iterator	payload_begin () const
PayloadContainer::const_iterator	payload_end () const

---

Detailed Description

Message Signature.

The Message Signature class contains an abstraction of a message (for message-passing based interactions), which contains a message label (for identifying messages) and optionally payload types (see MsgPayload).

---

Constructor & Destructor Documentation

sesstype::MsgSig::MsgSig

(

std::string

label

)

[inline]

MsgSig constructor.

Parameters:

[in]

label

of the MsgSig.

---

Member Function Documentation

void sesstype::MsgSig::add_payload

(

MsgPayload *

payload

)

[inline]

Add a payload parameter to current MsgSig.

Parameters:

[in]

payload

to add.

bool sesstype::MsgSig::has_payload

(

std::string

name

)

const [inline]

Returns:

true if payload with name exists.

std::string sesstype::MsgSig::label

(

)

const [inline]

Returns:

label of the MsgSig.

unsigned int sesstype::MsgSig::num_payloads

(

)

const [inline]

Returns:

number of payload paramaters.

MsgPayload* sesstype::MsgSig::payload

(

unsigned int

idx

)

const [inline]

Returns:

payload by positional index.

MsgPayload* sesstype::MsgSig::payload

(

std::string

name

)

const [inline]

Returns:

payload by name.

---

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

• msg.h