Menu

device::nic::CAN::SocketCANDriver< IDDesc > Class Template Reference

The generic driver interface to the SocketCAN hardware. More...

#include <SocketCANDriver.h>

Data Structures

class  MOB

Public Member Functions

 SocketCANDriver ()
 ~SocketCANDriver ()
bool read (MOB &mob)
void write (MOB &mob)
 transmits a CAN message object
void init ()
 initalize the driver by trying to open and bind a socket

Detailed Description

template<typename IDDesc = famouso::mw::nl::CAN::detail::famouso_CAN_ID_LE_PC>
class device::nic::CAN::SocketCANDriver< IDDesc >

The generic driver interface to the SocketCAN hardware.

Constructor & Destructor Documentation

template<typename IDDesc = famouso::mw::nl::CAN::detail::famouso_CAN_ID_LE_PC>
device::nic::CAN::SocketCANDriver< IDDesc >::SocketCANDriver (  )  [inline, explicit]
template<typename IDDesc = famouso::mw::nl::CAN::detail::famouso_CAN_ID_LE_PC>
device::nic::CAN::SocketCANDriver< IDDesc >::~SocketCANDriver (  )  [inline]

Member Function Documentation

template<typename IDDesc = famouso::mw::nl::CAN::detail::famouso_CAN_ID_LE_PC>
void device::nic::CAN::SocketCANDriver< IDDesc >::init (  )  [inline]

initalize the driver by trying to open and bind a socket

References PF_CAN.

template<typename IDDesc = famouso::mw::nl::CAN::detail::famouso_CAN_ID_LE_PC>
bool device::nic::CAN::SocketCANDriver< IDDesc >::read ( MOB &  mob  )  [inline]

try receiving a CAN message object

Parameters:
[out] mob is filled with a received message
Returns:
true if, a message was received
false otherwise
template<typename IDDesc = famouso::mw::nl::CAN::detail::famouso_CAN_ID_LE_PC>
void device::nic::CAN::SocketCANDriver< IDDesc >::write ( MOB &  mob  )  [inline]

transmits a CAN message object

Parameters:
[in] mob that has to be transmitted
The documentation for this class was generated from the following file: