eRPC API Reference  Rev. 1.11.0
NXP Semiconductors
erpc_framed_transport.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014-2016, Freescale Semiconductor, Inc.
3  * Copyright 2016-2020 NXP
4  * Copyright 2021 ACRIOS Systems s.r.o.
5  * All rights reserved.
6  *
7  *
8  * SPDX-License-Identifier: BSD-3-Clause
9  */
10 
11 #ifndef _EMBEDDED_RPC__FRAMED_TRANSPORT_H_
12 #define _EMBEDDED_RPC__FRAMED_TRANSPORT_H_
13 
14 #include "erpc_config_internal.h"
15 #include "erpc_message_buffer.hpp"
16 #include "erpc_transport.hpp"
17 
18 #include <cstring>
19 
20 #if !ERPC_THREADS_IS(NONE)
21 #include "erpc_threading.h"
22 #endif
23 
30 // Classes
33 
34 namespace erpc {
35 
56 class FramedTransport : public Transport
57 {
58 public:
62  FramedTransport(void);
63 
67  virtual ~FramedTransport(void);
68 
86  virtual erpc_status_t receive(MessageBuffer *message) override;
87 
96  virtual erpc_status_t send(MessageBuffer *message) override;
97 
99  struct Header
100  {
101  uint16_t m_messageSize;
102  uint16_t m_crc;
103  };
104 
110  virtual void setCrc16(Crc16 *crcImpl) override;
111 
117  virtual Crc16 *getCrc16() override;
118 
119 protected:
122 #if !ERPC_THREADS_IS(NONE)
125 #endif
126 
136  virtual erpc_status_t underlyingSend(const uint8_t *data, uint32_t size) = 0;
137 
147  virtual erpc_status_t underlyingReceive(uint8_t *data, uint32_t size) = 0;
148 };
149 
150 } // namespace erpc
151 
154 #endif // _EMBEDDED_RPC__FRAMED_TRANSPORT_H_
Abstract interface for transport layer.
Definition: erpc_transport.hpp:36
uint16_t m_messageSize
Size in bytes of the message, excluding the header.
Definition: erpc_framed_transport.hpp:101
Base class for framed transport layers.
Definition: erpc_framed_transport.hpp:56
enum _erpc_status erpc_status_t
Type used for all status and error return values.
Definition: erpc_common.h:85
Contents of the header that prefixes each message.
Definition: erpc_framed_transport.hpp:99
uint16_t m_crc
CRC-16 over the message data.
Definition: erpc_framed_transport.hpp:102
virtual ~FramedTransport(void)
FramedTransport destructor.
Definition: erpc_framed_transport.cpp:35
virtual erpc_status_t send(MessageBuffer *message) override
Function to send prepared message.
Definition: erpc_framed_transport.cpp:109
Represents a memory buffer containing a message.
Definition: erpc_message_buffer.hpp:37
virtual erpc_status_t underlyingReceive(uint8_t *data, uint32_t size)=0
Subclasses must implement this function to receive data.
Mutex m_sendLock
Mutex protecting send.
Definition: erpc_framed_transport.hpp:123
Definition: erpc_arbitrated_client_manager.hpp:25
FramedTransport(void)
Constructor.
Definition: erpc_framed_transport.cpp:25
virtual erpc_status_t underlyingSend(const uint8_t *data, uint32_t size)=0
Subclasses must implement this function to send data.
Class for compute crc16.
Definition: erpc_crc16.hpp:29
virtual Crc16 * getCrc16() override
This functions gets the CRC-16 object.
Definition: erpc_framed_transport.cpp:43
Crc16 * m_crcImpl
Definition: erpc_framed_transport.hpp:120
virtual void setCrc16(Crc16 *crcImpl) override
This functions sets the CRC-16 implementation.
Definition: erpc_framed_transport.cpp:37
Mutex m_receiveLock
Mutex protecting receive.
Definition: erpc_framed_transport.hpp:124
virtual erpc_status_t receive(MessageBuffer *message) override
Receives an entire message.
Definition: erpc_framed_transport.cpp:48
Mutex.
Definition: erpc_threading.h:338