CanListener Class Reference

#include <can_listener.h>

Inheritance diagram for CanListener:

Collaboration diagram for CanListener:

Public Member Functions
	CanListener (uint32_t id)
CanListener *	processFrame (const size_t busIndex, const CANRxFrame &frame, efitick_t nowNt)
uint32_t	getId ()
void	setNext (CanListener *next)
virtual CanListener *	request ()
CanListener *	getNext () const
virtual bool	acceptFrame (const size_t busIndex, const CANRxFrame &frame) const

Protected Member Functions
virtual void	decodeFrame (const CANRxFrame &frame, efitick_t nowNt)=0

Private Attributes
CanListener *	m_next = nullptr
const uint32_t	m_id

Detailed Description

Definition at line 12 of file can_listener.h.

Constructor & Destructor Documentation

CanListener()

CanListener::CanListener ( uint32_t  id )

inline

Definition at line 14 of file can_listener.h.

        : m_id(id)
    {
    }

Member Function Documentation

acceptFrame()

virtual bool CanListener::acceptFrame ( const size_t  busIndex, const CANRxFrame &  frame  ) const

inlinevirtual

Reimplemented in AemXSeriesWideband.

Definition at line 46 of file can_listener.h.

                                                                                   {
        /* accept from all buses */
        (void)busIndex;
 
        return CAN_ID(frame) == m_id;
    }

Referenced by processFrame().

Here is the caller graph for this function:

decodeFrame()

virtual void CanListener::decodeFrame ( const CANRxFrame &  frame, efitick_t  nowNt  )

protectedpure virtual

Implemented in CanTsListener, IsoTpRx, CanSensor< TStorage, TScale >, ObdCanSensor< Size, Offset >, AemXSeriesEgt, and AemXSeriesWideband.

Referenced by processFrame().

Here is the caller graph for this function:

getId()

uint32_t CanListener::getId ( )

inline

Definition at line 27 of file can_listener.h.

                     {
        return m_id;
    }

getNext()

CanListener * CanListener::getNext ( ) const

inline

Definition at line 40 of file can_listener.h.

                                 {
        return m_next;
    }

Referenced by registerCanListener(), request(), and unregisterCanListener().

Here is the caller graph for this function:

processFrame()

CanListener * CanListener::processFrame ( const size_t  busIndex, const CANRxFrame &  frame, efitick_t  nowNt  )

inline

Definition at line 19 of file can_listener.h.

                                                                                               {
        if (acceptFrame(busIndex, frame)) {
            decodeFrame(frame, nowNt);
        }
 
        return m_next;
    }

Referenced by serviceCanSubscribers().

Here is the call graph for this function:

Here is the caller graph for this function:

request()

virtual CanListener * CanListener::request ( void  )

inlinevirtual

Reimplemented in ObdCanSensor< Size, Offset >.

Definition at line 35 of file can_listener.h.

                                   {
        // NOP and return next in list
        return getNext();
    }

Referenced by CanWrite::PeriodicTask(), and ObdCanSensor< Size, Offset >::request().

Here is the call graph for this function:

Here is the caller graph for this function:

setNext()

void CanListener::setNext ( CanListener *  next )

inline

Definition at line 31 of file can_listener.h.

                                    {
        m_next = next;
    }

Referenced by registerCanListener(), and unregisterCanListener().

Here is the caller graph for this function:

Field Documentation

m_id

const uint32_t CanListener::m_id

private

Definition at line 59 of file can_listener.h.

Referenced by acceptFrame(), and getId().

m_next

CanListener* CanListener::m_next = nullptr

private

Definition at line 57 of file can_listener.h.

Referenced by getNext(), processFrame(), and setNext().

---

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

• controllers/can/can_listener.h