Mailbox.h

Go to the documentation of this file.

// (c) IMT - Information Management Technology AG, CH-9470 Buchs, www.imt.ch.
//
// ActiveParts (AP) and the corresponding Data Flow Framework (DFF) is invented and designed by Jakob Daescher.
// ANY USE OF THIS CODE CONSTITUTES ACCEPTANCE OF THE TERMS OF THE COPYRIGHT NOTICE.
// ===================================================================================================
// COPYRIGHT NOTICE
// ===================================================================================================
// Copyright (C) 2005-2075, IMT Information Management Technology AG, 9470 Buchs, Switzerland
// All rights reserved.
// This code is proprietary software of IMT Information Management Technology AG (hereinafter: "IMT").
// Proprietary software is computer software licensed under exclusive legal right of IMT.
//
// The licensee is given the irrevocable, perpetual, worldwide, non-exclusive right and license to use,
// execute and reproduce the software in binary form within the licensed products.
//
// Redistribution and use in source forms, without modification, are permitted provided that the following conditions are met:
// (1) Copying of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
// (2) Copying of source code is only allowed for regulatory documentation and archiving purposes
// (3) Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
//
// IMT provide no reassurances that the source code provided does not infringe
// any patent, copyright, or any other intellectual property rights of third parties.
// IMT disclaim any liability to any recipient for claims brought against
// recipient by any third party for infringement of that parties intellectual property rights.
//
// THIS SOFTWARE IS PROVIDED BY IMT AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL IMT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
// OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCURE-MENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
// IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// ===================================================================================================
 
#ifndef IMT_BASE_DFF_RUNTIME_RTOS_MAILBOX_H
#define IMT_BASE_DFF_RUNTIME_RTOS_MAILBOX_H
 
#include <Imt.Base.Core.Platform/Noncopyable.h>
#include <Imt.Base.Core.Platform/Platform.h>
#include <Imt.Base.Dff.Runtime.RTOS/MailboxImplIfc.h>
 
namespace imt {
namespace base {
namespace dff {
namespace runtime {
namespace rtos {
 
template<typename MessageType, size_t const MailboxSize>
class Mailbox final : private ::imt::base::core::platform::Noncopyable {
 
public:
 
    Mailbox(imt::base::dff::runtime::rtos::MailboxImplIfc& impl);
 
    inline void initialize();
 
    inline void deinitialize();
 
    inline void clear();
 
    inline MessageType getMail();
 
    inline bool getMailConditional(MessageType* const pMail);
 
    inline void putMail(MessageType const message);
 
    inline bool putMailConditional(MessageType const message);
 
    inline void waitMail();
 
private:
 
    void serialize(MessageType const message, uint8_t* const pData);
    MessageType deserialize(uint8_t const* const pData);
 
    uint8_t m_buffer[MailboxSize * sizeof(MessageType)];
    imt::base::dff::runtime::rtos::MailboxImplIfc& m_impl;
};
 
 
// public interface
template<typename MessageType, size_t const MailboxSize>
Mailbox<MessageType, MailboxSize>::Mailbox(imt::base::dff::runtime::rtos::MailboxImplIfc& impl) :
    m_buffer {},
    m_impl {impl} {
}
 
template<typename MessageType, size_t const MailboxSize>
void Mailbox<MessageType, MailboxSize>::initialize() {
    m_impl.initialize(m_buffer, sizeof(MessageType), MailboxSize);
}
 
template<typename MessageType, size_t const MailboxSize>
void Mailbox<MessageType, MailboxSize>::deinitialize() {
    m_impl.deinitialize();
}
 
template<typename MessageType, size_t const MailboxSize>
void Mailbox<MessageType, MailboxSize>::clear() {
    m_impl.clear();
}
 
template<typename MessageType, size_t const MailboxSize>
inline MessageType Mailbox<MessageType, MailboxSize>::getMail() {
    uint8_t data[sizeof(MessageType)];
    m_impl.getMail(data, sizeof(MessageType));
    return deserialize(data);
}
 
template<typename MessageType, size_t const MailboxSize>
inline bool Mailbox<MessageType, MailboxSize>::getMailConditional(MessageType* const pMessage) {
    if (pMessage == nullptr) {
        ASSERT_DEBUG(false); // null pointer
        return false;
    }
 
    uint8_t data[sizeof(MessageType)];
    if (!m_impl.getMailConditional(data, sizeof(MessageType))) {
        return false;
    }
 
    *pMessage = deserialize(data);
    return true;
}
 
template<typename MessageType, size_t const MailboxSize>
inline void Mailbox<MessageType, MailboxSize>::putMail(MessageType const message) {
    uint8_t data[sizeof(MessageType)];
    serialize(message, data);
    m_impl.putMail(data, sizeof(MessageType));
}
 
template<typename MessageType, size_t const MailboxSize>
inline bool Mailbox<MessageType, MailboxSize>::putMailConditional(MessageType const message) {
    uint8_t data[sizeof(MessageType)];
    serialize(message, data);
    return m_impl.putMailConditional(data, sizeof(MessageType));
}
 
template<typename MessageType, size_t const MailboxSize>
void Mailbox<MessageType, MailboxSize>::serialize(MessageType const message, uint8_t* const pData) {
    if (pData == nullptr) {
        ASSERT_DEBUG(false); // null pointer
        return;
    }
 
    size_t offset {0};
    for (size_t i {0}; i < sizeof(MessageType); ++i) {
        pData[i] = static_cast<uint8_t>(message >> offset);
        offset += 8;
    }
}
 
template<typename MessageType, size_t const MailboxSize>
MessageType Mailbox<MessageType, MailboxSize>::deserialize(uint8_t const* const pData) {
    if (pData == nullptr) {
        ASSERT_DEBUG(false); // null pointer
        return 0;
    }
 
    MessageType message {0};
    size_t offset {0U};
    for (size_t i {0}; i < sizeof(MessageType); ++i) {
        message |= (pData[i] << offset);
        offset += 8U;
    }
    return message;
}
 
} // namespace rtos
} // namespace runtime
} // namespace dff
} // namespace base
} // namespace imt
 
#endif // IMT_BASE_DFF_RUNTIME_RTOS_MAILBOX_H