eRPC API Reference  Rev. 1.12.0
NXP Semiconductors
erpc::SerialTransport Class Reference

Serial transport layer for host PC. More...

#include <erpc_serial_transport.hpp>

+ Inheritance diagram for erpc::SerialTransport:
+ Collaboration diagram for erpc::SerialTransport:

Public Member Functions

 SerialTransport (const char *portName, speed_t baudRate)
 Constructor. More...
 
virtual ~SerialTransport (void)
 Destructor.
 
erpc_status_t init (uint8_t vtime, uint8_t vmin)
 Initialize Serial peripheral. More...
 
- Public Member Functions inherited from erpc::FramedTransport
 FramedTransport (void)
 Constructor.
 
virtual ~FramedTransport (void)
 FramedTransport destructor.
 
virtual uint8_t reserveHeaderSize (void) override
 Size of data placed in MessageBuffer before serializing eRPC data. More...
 
virtual erpc_status_t receive (MessageBuffer *message) override
 Receives an entire message. More...
 
virtual erpc_status_t send (MessageBuffer *message) override
 Function to send prepared message. More...
 
virtual void setCrc16 (Crc16 *crcImpl) override
 This functions sets the CRC-16 implementation. More...
 
virtual Crc16getCrc16 (void) override
 This functions gets the CRC-16 object. More...
 
- Public Member Functions inherited from erpc::Transport
 Transport (void)
 Constructor.
 
virtual ~Transport (void)
 Transport destructor.
 
virtual bool hasMessage (void)
 Poll for an incoming message. More...
 

Additional Inherited Members

- Protected Member Functions inherited from erpc::FramedTransport
virtual erpc_status_t underlyingSend (MessageBuffer *message, uint32_t size, uint32_t offset)
 Adds ability to framed transport to overwrite MessageBuffer when sending data. More...
 
virtual erpc_status_t underlyingReceive (MessageBuffer *message, uint32_t size, uint32_t offset)
 Adds ability to framed transport to overwrite MessageBuffer when receiving data. More...
 
- Protected Attributes inherited from erpc::FramedTransport
Crc16m_crcImpl
 
Mutex m_sendLock
 Mutex protecting send.
 
Mutex m_receiveLock
 Mutex protecting receive.
 

Detailed Description

Serial transport layer for host PC.

Constructor & Destructor Documentation

SerialTransport::SerialTransport ( const char *  portName,
speed_t  baudRate 
)

Constructor.

Parameters
[in]portNamePort name.
[in]baudRateBaudrate.

Member Function Documentation

erpc_status_t SerialTransport::init ( uint8_t  vtime,
uint8_t  vmin 
)

Initialize Serial peripheral.

Parameters
[in]vtimeRead timeout.
[in]vminRead timeout min.
Returns
Status of init function.

The documentation for this class was generated from the following files: