erpc::RPMsgLinuxTransport Class Reference

RPMSG Linux transport to send/receive messages through RPMSG endpoints based on github.com/nxp-mcuxpresso/rpmsg-sysfs/tree/0aa1817545a765c200b1b2f9b6680a420dcf9171 implementation. More...

#include <erpc_rpmsg_linux_transport.hpp>

Inheritance diagram for erpc::RPMsgLinuxTransport:

Collaboration diagram for erpc::RPMsgLinuxTransport:

Public Member Functions
	RPMsgLinuxTransport (RPMsgEndpoint *endPoint, int16_t remote)
	Constructor to set RPMsg endpoint and remote address.
RPMsgEndpoint *	getRpmsgEndpoint (void)
	This function returns rpmsg endpoint object. More...
erpc_status_t	init (void)
	This function initializes Linux environment for sending and receiving messages. More...
virtual erpc_status_t	receive (MessageBuffer *message) override
	This function receives the eRPC messages. More...
virtual erpc_status_t	send (MessageBuffer *message) override
	This function sends the eRPC messages. More...
Public Member Functions inherited from erpc::Transport
	Transport (void)
	Constructor.
virtual	~Transport (void)
	Transport destructor.
virtual uint8_t	reserveHeaderSize (void)
	Size of data placed in MessageBuffer before serializing eRPC data. More...
virtual bool	hasMessage (void)
	Poll for an incoming message. More...
virtual void	setCrc16 (Crc16 *crcImpl)
	This functions sets the CRC-16 implementation. More...
virtual Crc16 *	getCrc16 (void)
	This functions gets the CRC-16 object. More...

Detailed Description

RPMSG Linux transport to send/receive messages through RPMSG endpoints based on github.com/nxp-mcuxpresso/rpmsg-sysfs/tree/0aa1817545a765c200b1b2f9b6680a420dcf9171 implementation.

Member Function Documentation

RPMsgEndpoint* erpc::RPMsgLinuxTransport::getRpmsgEndpoint ( void  )

inline

This function returns rpmsg endpoint object.

Returns

RPMsgEndpoint * Rpmsg endpoint.

erpc_status_t RPMsgLinuxTransport::init

(

void

)

This function initializes Linux environment for sending and receiving messages.

Return values

kErpcStatus_Success	When environment was set successfully.
kErpcStatus_Fail	When environment wasn't set successfully.

erpc_status_t RPMsgLinuxTransport::receive ( MessageBuffer *  message )

overridevirtual

This function receives the eRPC messages.

Parameters

[in]

message

Message to receive.

Return values

kErpcStatus_Success	When message was received successfully.
kErpcStatus_Fail	When message wasn't received successfully.

Implements erpc::Transport.

erpc_status_t RPMsgLinuxTransport::send ( MessageBuffer *  message )

overridevirtual

This function sends the eRPC messages.

Parameters

[in]

message

Message to send.

Return values

kErpcStatus_Success	When message was sent successfully.
kErpcStatus_Fail	When message wasn't sent successfully.

Implements erpc::Transport.

---

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

• erpc_rpmsg_linux_transport.hpp
• erpc_rpmsg_linux_transport.cpp