ifw-ccf 5.0.2
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
ifw::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.
 
 ~Response ()
 
const MessageGetMessage () const
 Get reference to original message object (for which the response was sent).
 
const std::string & Code () const
 Return application specific response code.
 
const std::string & Data () const
 Return response data (payload).
 
std::string ToString (const uint16_t truncate=128) const
 Generate ASCII output providing a status of the object.
 
Responseoperator= (const Response &source)
 

Protected Attributes

ifw::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]

ifw::ccf::mptk::Response::Response ( )

◆ Response() [2/3]

ifw::ccf::mptk::Response::Response ( const Response & source)

◆ Response() [3/3]

ifw::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
messageMessage object received.
response_codeApplication specific response code, e.g. "OK" or "ERROR".
response_dataResponse data (payload).

◆ ~Response()

ifw::ccf::mptk::Response::~Response ( )

Member Function Documentation

◆ Code()

const std::string & ifw::ccf::mptk::Response::Code ( ) const

Return application specific response code.

◆ Data()

const std::string & ifw::ccf::mptk::Response::Data ( ) const

Return response data (payload).

◆ GetMessage()

const Message & ifw::ccf::mptk::Response::GetMessage ( ) const

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

◆ operator=()

Response & ifw::ccf::mptk::Response::operator= ( const Response & source)

◆ ToString()

std::string ifw::ccf::mptk::Response::ToString ( const uint16_t truncate = 128) const

Generate ASCII output providing a status of the object.

Member Data Documentation

◆ m_message

ifw::ccf::mptk::Message ifw::ccf::mptk::Response::m_message
protected

◆ m_response_code

std::string ifw::ccf::mptk::Response::m_response_code
protected

◆ m_response_data

std::string ifw::ccf::mptk::Response::m_response_data
protected

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