ccf::mptk::Response Class Reference

IFW CTD Multiprocessing Toolkit Response class. More...

#include <response.hpp>

Public Member Functions
	Response ()
	Response (const Response &source)
	Response (const Message &message, const std::string &response_code, const std::string &response_data)
	Constructor setting the members of response object. More...
	~Response ()
const Message &	GetMessage () const
	Get reference to original message object (for which the response was sent). More...
const std::string &	Code () const
	Return application specific response code. More...
const std::string &	Data () const
	Return response data (payload). More...
std::string	ToString (const uint16_t truncate=128) const
	Generate ASCII output providing a status of the object. More...
Response &	operator= (const Response &source)

Protected Attributes
ccf::mptk::Message	m_message
std::string	m_response_code
std::string	m_response_data

Detailed Description

IFW CTD Multiprocessing Toolkit Response class.

The MPTK Response class is used to transfer information in connection wehen responding to a MPTK Message sent.

Constructor & Destructor Documentation

Response() [1/3]

ccf::mptk::Response::Response

(

)

Response() [2/3]

ccf::mptk::Response::Response

(

const Response &

source

)

Response() [3/3]

ccf::mptk::Response::Response	(	const Message &	message,
		const std::string &	response_code,
		const std::string &	response_data
	)

Constructor setting the members of response object.

Parameters

message	Message object received.
response_code	Application specific response code, e.g. "OK" or "ERROR".
response_data	Response data (payload).

~Response()

ccf::mptk::Response::~Response

(

)

Member Function Documentation

Code()

const std::string & ccf::mptk::Response::Code

(

)

const

Return application specific response code.

Data()

const std::string & ccf::mptk::Response::Data

(

)

const

Return response data (payload).

GetMessage()

const Message & ccf::mptk::Response::GetMessage

(

)

const

Get reference to original message object (for which the response was sent).

operator=()

Response & ccf::mptk::Response::operator=

(

const Response &

source

)

ToString()

std::string ccf::mptk::Response::ToString

(

const uint16_t

truncate = 128

)

const

Generate ASCII output providing a status of the object.

Member Data Documentation

m_message

ccf::mptk::Message ccf::mptk::Response::m_message

protected

m_response_code

std::string ccf::mptk::Response::m_response_code

protected

m_response_data

std::string ccf::mptk::Response::m_response_data

protected

---

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

• mptk/src/include/ccf/mptk/response.hpp
• mptk/src/response.cpp