CANObserver Class Reference

Interface. Receives notifications about the CAN bus traffic and errors. More...

#include <canobserver.h>

Inheritance diagram for CANObserver:

Public Types
enum	CANError { GENERAL_ERROR = 0 }

Public Member Functions
virtual void	errorOccured (CANObserver::CANError error)=0
virtual void	standardFrameReceived (const can_frame &frame)=0
virtual void	extendedFrameReceived (const can_frame &frame)=0
virtual void	errorFrameReceived (const can_frame &frame)=0
virtual void	remoteTransmissionRequest (const can_frame &frame)=0
virtual void	timeoutDetected (const can_frame &frame)=0

Detailed Description

Interface. Receives notifications about the CAN bus traffic and errors.

CANBus user has to derive from this interface.

Member Enumeration Documentation

enum CANObserver::CANError

General CAN bus error. Currently only GENERAL_ERROR is specified.

Member Function Documentation

CANObserver::errorFrameReceived ( const can_frame &  frame )

pure virtual

Called when error frame was received from the bus.

Parameters

frame

Error frame

Implemented in CANGenPlugin, and CANSimPlugin.

CANObserver::errorOccured ( CANObserver::CANError  error )

pure virtual

Called when error occurred on the bus.

Parameters

error

Bus error code

Implemented in CANGenPlugin, and CANSimPlugin.

CANObserver::extendedFrameReceived ( const can_frame &  frame )

pure virtual

Called when extended frame was is received from the bus.

Parameters

frame

Received frame

Implemented in CANGenPlugin, and CANSimPlugin.

CANObserver::remoteTransmissionRequest ( const can_frame &  frame )

pure virtual

Called when remote transmission frame was received from the bus.

Parameters

frame

RTR frame

Implemented in CANGenPlugin, and CANSimPlugin.

CANObserver::standardFrameReceived ( const can_frame &  frame )

pure virtual

Called when standard frame was is received from the bus.

Parameters

frame

Received frame

Implemented in CANGenPlugin, and CANSimPlugin.

CANObserver::timeoutDetected ( const can_frame &  frame )

pure virtual

Called when timeout was detected for a cyclic message.

Parameters

frame

Implemented in CANGenPlugin, and CANSimPlugin.

---

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

• /home/abuild/rpmbuild/BUILD/automotive-message-broker-0.15/plugins/common/canobserver.h