/** * @file include/ActivMiddleware/ActivFramework/HeapMessageDeserializer.h * * @brief Header file for the heap message deserializer template class. */ #if (!defined ACTIV_FRAMEWORK_HEAP_MESSAGE_DESERIALIZER_H) #define ACTIV_FRAMEWORK_HEAP_MESSAGE_DESERIALIZER_H #include "ActivMiddleware/ActivBase/MessageValidator.h" #if (defined ACTIV_LITE_FRAMEWORK) #include "ActivMiddleware/ActivLiteFramework/Message.h" #else #include "ActivMiddleware/ActivFramework/HeapMessage.h" #endif //! Activ namespace. namespace Activ { #if (!defined ACTIV_LITE_FRAMEWORK) /** * @brief Template class to wrap up deserializing a HeapMessage. * * @param MESSAGE_TYPE type of message to deserialize. Must have a StatusCode Deserialize(MessageValidator &) method. * @param BUFFER_SIZE (UNUSED). */ template class HeapMessageDeserializer : private Boost::noncopyable { public: /** * @brief Initialize by getting a pointer to a contiguous block containing the contents of a HeapMessage. * * @param heapMessage the HeapMessage to initialize from. * @param messageVersion optional message version. * * @retval STATUS_CODE_SUCCESS * @retval STATUS_CODE_HEAP_EMPTY */ StatusCode Initialize(const HeapMessage &heapMessage, const MessageHandler::MessageVersion messageVersion = MessageHandler::MESSAGE_VERSION_UNDEFINED); /** * @brief Deserialize from the current position. * * @param message object to deserialize into. * * @retval STATUS_CODE_SUCCESS * @retval ... */ StatusCode Deserialize(MESSAGE_TYPE &message); /** * @brief Deserialize the contents of a HeapMessage into an object. * * Use this method if the HeapMessage contains only one instance of a message. * * @param heapMessage the HeapMessage to initialize from. * @param message object to deserialize into. * @param messageVersion optional message version. * * @retval STATUS_CODE_SUCCESS * @retval STATUS_CODE_INVALID_FORMAT * @retval STATUS_CODE_HEAP_EMPTY * @retval ... */ StatusCode operator()(const HeapMessage &heapMessage, MESSAGE_TYPE &message, const MessageHandler::MessageVersion messageVersion = MessageHandler::MESSAGE_VERSION_UNDEFINED); //! Has all data been deserialized from the HeapMessage? bool IsEndOfMessage() const; private: MessageValidator m_messageValidator; }; // --------------------------------------------------------------------------------------------------------------------------------- template inline StatusCode HeapMessageDeserializer::Initialize(const HeapMessage &heapMessage, const MessageHandler::MessageVersion messageVersion) { return heapMessage.Get(m_messageValidator, messageVersion); } // --------------------------------------------------------------------------------------------------------------------------------- template inline StatusCode HeapMessageDeserializer::Deserialize(MESSAGE_TYPE &message) { return message.Deserialize(m_messageValidator); } // --------------------------------------------------------------------------------------------------------------------------------- template inline StatusCode HeapMessageDeserializer::operator()(const HeapMessage &heapMessage, MESSAGE_TYPE &message, const MessageHandler::MessageVersion messageVersion) { ACTIV_RETURN_RESULT_IF_UNLIKELY(STATUS_CODE_SUCCESS, !=, Initialize(heapMessage, messageVersion)); ACTIV_RETURN_RESULT_IF_UNLIKELY(STATUS_CODE_SUCCESS, !=, Deserialize(message)); return IsEndOfMessage() ? STATUS_CODE_SUCCESS : STATUS_CODE_INVALID_LENGTH; } // --------------------------------------------------------------------------------------------------------------------------------- template inline bool HeapMessageDeserializer::IsEndOfMessage() const { return m_messageValidator.IsEndOfMessage(); } #endif // (!defined ACTIV_LITE_FRAMEWORK) // --------------------------------------------------------------------------------------------------------------------------------- // --------------------------------------------------------------------------------------------------------------------------------- /** * @brief Deserialize the contents of a HeapMessage into an object. * * @param heapMessage the HeapMessage to initialize from. * @param message object to deserialize into. * @param messageVersion optional message version. * * @throw StatusCodeException */ template #if (defined ACTIV_LITE_FRAMEWORK) inline void DeserializeHeapMessage(const Lite::Message &heapMessage, MESSAGE_TYPE &message, const MessageHandler::MessageVersion messageVersion = MessageHandler::MESSAGE_VERSION_UNDEFINED) { MessageValidator messageValidator(heapMessage.GetData(), heapMessage.GetLength(), messageVersion); ACTIV_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, message.Deserialize(messageValidator)); } #else inline void DeserializeHeapMessage(const HeapMessage &heapMessage, MESSAGE_TYPE &message, const MessageHandler::MessageVersion messageVersion = MessageHandler::MESSAGE_VERSION_UNDEFINED) { MessageValidator messageValidator; ACTIV_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, heapMessage.Get(messageValidator, messageVersion)); ACTIV_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, message.Deserialize(messageValidator)); } #endif } // namespace Activ #endif // (!defined ACTIV_FRAMEWORK_HEAP_MESSAGE_DESERIALIZER_H)