erpc_framed_transport.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2016, Freescale Semiconductor, Inc.
 * Copyright 2016-2020 NXP
 * Copyright 2021 ACRIOS Systems s.r.o.
 * All rights reserved.
 *
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

#ifndef _EMBEDDED_RPC__FRAMED_TRANSPORT_H_
#define _EMBEDDED_RPC__FRAMED_TRANSPORT_H_

#include "erpc_config_internal.h"
#include "erpc_message_buffer.hpp"
#include "erpc_transport.hpp"

#include <cstring>

#if !ERPC_THREADS_IS(NONE)
#include "erpc_threading.h"
#endif

// Classes

namespace erpc {

class FramedTransport : public Transport
{
public:
    struct Header
    {
        uint16_t m_crcHeader;   
        uint16_t m_messageSize; 
        uint16_t m_crcBody;     
    };

    FramedTransport(void);

    virtual ~FramedTransport(void);

    virtual uint8_t reserveHeaderSize(void) override;

    virtual erpc_status_t receive(MessageBuffer *message) override;

    virtual erpc_status_t send(MessageBuffer *message) override;

    virtual void setCrc16(Crc16 *crcImpl) override;

    virtual Crc16 *getCrc16(void) override;

protected:
    Crc16 *m_crcImpl; 
#if !ERPC_THREADS_IS(NONE)
    Mutex m_sendLock;    
    Mutex m_receiveLock; 
#endif

    virtual erpc_status_t underlyingSend(MessageBuffer *message, uint32_t size, uint32_t offset);

    virtual erpc_status_t underlyingReceive(MessageBuffer *message, uint32_t size, uint32_t offset);

    virtual erpc_status_t underlyingSend(const uint8_t *data, uint32_t size) = 0;

    virtual erpc_status_t underlyingReceive(uint8_t *data, uint32_t size) = 0;
};

} // namespace erpc

#endif // _EMBEDDED_RPC__FRAMED_TRANSPORT_H_