blob: 549f0700f04be3d4bedbd1c3fb98cc598458c478 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
/*
Copyright (C) 2012 Intel Corporation
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef CANOBSERVER_H
#define CANOBSERVER_H
/**
* \addtogroup libcanbus
* @{
*/
#include <stdlib.h>
#include <linux/can.h>
#include "canframeinfo.h"
/**
* \brief Interface. Receives notifications about the CAN bus traffic and errors.
*
* CANBus user has to derive from this interface.
* @class CANObserver
*/
class CANObserver
{
public:
/**
* General CAN bus error. Currently only GENERAL_ERROR is specified.
* @enum CANError
* @public
*/
enum CANError {
GENERAL_ERROR = 0
};
virtual ~CANObserver(){} /*LCOV_EXCL_LINE*/
/**
* Called when error occurred on the bus.
* @fn errorOccured
* @param error Bus error code
*/
virtual void errorOccured(CANObserver::CANError error) = 0; /* socket error */
/**
* Called when standard frame was is received from the bus.
* @fn standardFrameReceived
* @param frame Received frame
*/
virtual void standardFrameReceived(const can_frame& frame) = 0; /* SFF was present */
/**
* Called when extended frame was is received from the bus.
* @fn extendedFrameReceived
* @param frame Received frame
*/
virtual void extendedFrameReceived(const can_frame& frame) = 0; /* EFF was present */
/**
* Called when error frame was received from the bus.
* @fn errorFrameReceived
* @param frame Error frame
*/
virtual void errorFrameReceived(const can_frame& frame) = 0; /* error frame */
/**
* Called when remote transmission frame was received from the bus.
* @fn remoteTransmissionRequest
* @param frame RTR frame
*/
virtual void remoteTransmissionRequest(const can_frame& frame) = 0; /* remote transmission request (SFF/EFF is still present)*/
/**
* Called when timeout was detected for a cyclic message.
* @fn timeoutDetected
* @param frame
*/
virtual void timeoutDetected(const can_frame& frame) = 0; /* timeout */
};
#endif // CANOBSERVER_H
/** @} */
|
