eip::MessageRouterResponse Class Reference

#include <message_router_response.h>

Inheritance diagram for eip::MessageRouterResponse:

Public Member Functions
virtual Reader &	deserialize (Reader &reader, size_t length)
virtual Reader &	deserialize (Reader &reader)
shared_ptr< Serializable >	getAdditionalStatus () const
virtual size_t	getLength () const
shared_ptr< Serializable >	getResponseData () const
	MessageRouterResponse ()
virtual Writer &	serialize (Writer &writer) const

Public Attributes
EIP_USINT	general_status
EIP_USINT	service

Private Member Functions
shared_ptr< Serializable >	readData (Reader &reader, int length)

Private Attributes
shared_ptr< Serializable >	additional_status_
shared_ptr< Serializable >	response_data_

Detailed Description

Class to encapsulate a MessageRouterResponse data.

Definition at line 48 of file message_router_response.h.

Constructor & Destructor Documentation

MessageRouterResponse()

eip::MessageRouterResponse::MessageRouterResponse ( )

inline

Construct an empty RR data holder

Definition at line 58 of file message_router_response.h.

Member Function Documentation

deserialize() [1/2]

Reader & eip::MessageRouterResponse::deserialize ( Reader &  reader, size_t  length  )

virtual

Deserialize response data from the given reader and length

Implements eip::serialization::Serializable.

Definition at line 52 of file message_router_response.cpp.

deserialize() [2/2]

virtual Reader& eip::MessageRouterResponse::deserialize ( Reader &  reader )

inlinevirtual

Not implemented. Never expect to have to receive this type of message.

Implements eip::serialization::Serializable.

Definition at line 103 of file message_router_response.h.

getAdditionalStatus()

shared_ptr<Serializable> eip::MessageRouterResponse::getAdditionalStatus ( ) const

inline

Get the additional status data object in this message

Returns

Serializable additional status to be used for this response

Definition at line 64 of file message_router_response.h.

getLength()

size_t eip::MessageRouterResponse::getLength ( ) const

virtual

Get the length of serialized data that would be produced if serialized

Returns

Total length in bytes to be serialized

Implements eip::serialization::Serializable.

Definition at line 37 of file message_router_response.cpp.

getResponseData()

shared_ptr<Serializable> eip::MessageRouterResponse::getResponseData ( ) const

inline

Get the response data object in this message

Returns

Serializable data to be used for this response

Definition at line 73 of file message_router_response.h.

readData()

shared_ptr< Serializable > eip::MessageRouterResponse::readData ( Reader &  reader, int  length  )

private

Helper to read data fields. Simply produces SerializableBuffers of the given length, or a null pointer if length <= 0.

Parameters

reader	Reader to use to read buffer data
length	Length in bytes to read. If less than or equal to zero, then null pointer is returned.

Returns

shared_ptr to a SerializableBuffer with the data read

Definition at line 65 of file message_router_response.cpp.

serialize()

virtual Writer& eip::MessageRouterResponse::serialize ( Writer &  writer ) const

inlinevirtual

Serialize data into the given buffer

Parameters

writer

Writer to use for serialization

Returns

the writer again

Exceptions

std::length_error

if the buffer is too small for the header data

Implements eip::serialization::Serializable.

Definition at line 90 of file message_router_response.h.

Member Data Documentation

additional_status_

shared_ptr<Serializable> eip::MessageRouterResponse::additional_status_

private

Definition at line 109 of file message_router_response.h.

general_status

EIP_USINT eip::MessageRouterResponse::general_status

Definition at line 53 of file message_router_response.h.

response_data_

shared_ptr<Serializable> eip::MessageRouterResponse::response_data_

private

Definition at line 110 of file message_router_response.h.

service

EIP_USINT eip::MessageRouterResponse::service

Definition at line 52 of file message_router_response.h.

---

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

• message_router_response.h
• message_router_response.cpp