iv::comms::socketcan::ISocketCANInterface Class Reference

Interface for communication with SocketCAN.Designed to be extended by different types of drivers. More...

#include <ISocketCANInterface.hpp>

Inheritance diagram for iv::comms::socketcan::ISocketCANInterface:

Public Member Functions
virtual	~ISocketCANInterface ()=default
virtual void *	ctrlOpen (const char *deviceId, iv::model::comms::socketcan::eBaudRate baudRate)=0
virtual uint32_t	ctrlInit (void *socket, iv::model::comms::socketcan::eBaudRate baudRate)=0
virtual uint32_t	ctrlReceive (void *socket, std::shared_ptr< CMessageCan > &pStcMessage)=0
virtual uint32_t	ctrlSend (void *socket, const CMessageCan &pStcMessage)=0
virtual void	ctrlClose (void *socket)=0

Static Protected Member Functions
static void	prvPeakKernelModuleLoad ()
static void	prvIxxatKernelModuleLoad ()
static bool	prvExistsInterface (const std::string &deviceId)
static bool	prvIsInterfaceUp (const std::string &deviceId)
static bool	prvSetInterface (const std::string &deviceId, bool up)
static bool	prvSetBitrate (const std::string &deviceId, uint64_t btr0)

Protected Attributes
std::string	m_interfaceName {}

Detailed Description

Interface for communication with SocketCAN.

Designed to be extended by different types of drivers.

Constructor & Destructor Documentation

~ISocketCANInterface()

virtual iv::comms::socketcan::ISocketCANInterface::~ISocketCANInterface ( )

virtualdefault

Member Function Documentation

ctrlClose()

virtual void iv::comms::socketcan::ISocketCANInterface::ctrlClose ( void * socket )

pure virtual

Implemented in iv::comms::socketcan::SocketCanSettings.

ctrlInit()

virtual uint32_t iv::comms::socketcan::ISocketCANInterface::ctrlInit ( void * socket, iv::model::comms::socketcan::eBaudRate baudRate )

pure virtual

Implemented in iv::comms::socketcan::SocketCanSettings.

ctrlOpen()

virtual void * iv::comms::socketcan::ISocketCANInterface::ctrlOpen ( const char * deviceId, iv::model::comms::socketcan::eBaudRate baudRate )

pure virtual

Implemented in iv::comms::socketcan::SocketCanSettings.

ctrlReceive()

virtual uint32_t iv::comms::socketcan::ISocketCANInterface::ctrlReceive ( void * socket, std::shared_ptr< CMessageCan > & pStcMessage )

pure virtual

Implemented in iv::comms::socketcan::SocketCanSettings.

ctrlSend()

virtual uint32_t iv::comms::socketcan::ISocketCANInterface::ctrlSend ( void * socket, const CMessageCan & pStcMessage )

pure virtual

Implemented in iv::comms::socketcan::SocketCanSettings.

prvExistsInterface()

static bool iv::comms::socketcan::ISocketCANInterface::prvExistsInterface ( const std::string & deviceId )

inlinestaticprotected

prvIsInterfaceUp()

static bool iv::comms::socketcan::ISocketCANInterface::prvIsInterfaceUp ( const std::string & deviceId )

inlinestaticprotected

prvIxxatKernelModuleLoad()

static void iv::comms::socketcan::ISocketCANInterface::prvIxxatKernelModuleLoad ( )

inlinestaticprotected

prvPeakKernelModuleLoad()

static void iv::comms::socketcan::ISocketCANInterface::prvPeakKernelModuleLoad ( )

inlinestaticprotected

prvSetBitrate()

static bool iv::comms::socketcan::ISocketCANInterface::prvSetBitrate ( const std::string & deviceId, uint64_t btr0 )

inlinestaticprotected

prvSetInterface()

static bool iv::comms::socketcan::ISocketCANInterface::prvSetInterface ( const std::string & deviceId, bool up )

inlinestaticprotected

Member Data Documentation

m_interfaceName

std::string iv::comms::socketcan::ISocketCANInterface::m_interfaceName {}

protected

---

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

• src/comms/socketcan/ISocketCANInterface.hpp