erpc_codec.hpp

Go to the documentation of this file.

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

#ifndef _EMBEDDED_RPC__CODEC_H_
#define _EMBEDDED_RPC__CODEC_H_

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

#include <cstdint>
#include <cstring>

// Classes

namespace erpc {
enum class message_type_t
{
    kInvocationMessage = 0,
    kOnewayMessage,
    kReplyMessage,
    kNotificationMessage
};

typedef void *funPtr;          // Pointer to functions
typedef funPtr *arrayOfFunPtr; // Pointer to array of functions

class Codec
{
public:
    Codec(void) : m_cursor(), m_status(kErpcStatus_Success) {}

    virtual ~Codec(void) {}

    MessageBuffer getBuffer(void) { return m_cursor.getBuffer(); }

    MessageBuffer &getBufferRef(void) { return m_cursor.getBufferRef(); }

    virtual void setBuffer(MessageBuffer &buf, uint8_t skip = 0)
    {
        m_cursor.setBuffer(buf, skip);
        m_status = kErpcStatus_Success;
    }

    virtual void reset(uint8_t skip = 0)
    {
        MessageBuffer buffer = m_cursor.getBuffer();
        m_cursor.setBuffer(buffer, skip);
        m_status = kErpcStatus_Success;
    }

    erpc_status_t getStatus(void) { return m_status; }

    bool isStatusOk(void) { return (m_status == kErpcStatus_Success); }

    void updateStatus(erpc_status_t status)
    {
        if (isStatusOk())
        {
            m_status = status;
        }
    }



    virtual void startWriteMessage(message_type_t type, uint32_t service, uint32_t request, uint32_t sequence) = 0;

    virtual void write(bool value) = 0;

    virtual void write(int8_t value) = 0;

    virtual void write(int16_t value) = 0;

    virtual void write(int32_t value) = 0;

    virtual void write(int64_t value) = 0;

    virtual void write(uint8_t value) = 0;

    virtual void write(uint16_t value) = 0;

    virtual void write(uint32_t value) = 0;

    virtual void write(uint64_t value) = 0;

    virtual void write(float value) = 0;

    virtual void write(double value) = 0;

    virtual void writePtr(uintptr_t value) = 0;

    virtual void writeString(uint32_t length, const char *value) = 0;

    virtual void writeBinary(uint32_t length, const uint8_t *value) = 0;

    virtual void startWriteList(uint32_t length) = 0;

    virtual void startWriteUnion(int32_t discriminator) = 0;

    virtual void writeNullFlag(bool isNull) = 0;



    virtual void startReadMessage(message_type_t &type, uint32_t &service, uint32_t &request, uint32_t &sequence) = 0;

    virtual void read(bool &value) = 0;

    virtual void read(int8_t &value) = 0;

    virtual void read(int16_t &value) = 0;

    virtual void read(int32_t &value) = 0;

    virtual void read(int64_t &value) = 0;

    virtual void read(uint8_t &value) = 0;

    virtual void read(uint16_t &value) = 0;

    virtual void read(uint32_t &value) = 0;

    virtual void read(uint64_t &value) = 0;

    virtual void read(float &value) = 0;

    virtual void read(double &value) = 0;

    virtual void readPtr(uintptr_t &value) = 0;

    virtual void readString(uint32_t &length, char **value) = 0;

    virtual void readBinary(uint32_t &length, uint8_t **value) = 0;

    virtual void startReadList(uint32_t &length) = 0;

    virtual void startReadUnion(int32_t &discriminator) = 0;

    virtual void readNullFlag(bool &isNull) = 0;

protected:
    Cursor m_cursor;        
    erpc_status_t m_status; 
};

class CodecFactory
{
public:
    CodecFactory(void) {}

    virtual ~CodecFactory(void) {}

    virtual Codec *create(void) = 0;

    virtual void dispose(Codec *codec) = 0;
};

} // namespace erpc

#endif // _EMBEDDED_RPC__CODEC_H_