summaryrefslogtreecommitdiff
path: root/plugins/common/cansocketreader.h
blob: 623430ae7ff22abe2d9cbdff90d002a74cd2146e (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
/*
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 CANSOCKETREADER_H
#define CANSOCKETREADER_H

/**
 *  \addtogroup libcanbus
 *  @{
 */

#include <sys/socket.h>

#include "thread.h"
#include "canobserver.h"

class CANSocket;
/**
* \brief Asynchronous socket CAN reader.
*
* @class CANSocketReader
*/
class CANSocketReader : public CUtil::Thread
{
public:
    /**
    * @param observer @link CANObserver Observer @endlink that will receives CAN bus frames.
    * @param socket @link CANSocket CAN Socket wrapper @endlink
    */
    CANSocketReader(CANObserver& observer, CANSocket& socket);
    virtual ~CANSocketReader();

    /**
    * Starts a new thread for listening to CAN bus.
    * @fn start
    * @return True if no error occurs.
    */

    virtual bool start();
    /**
    * Stops listening thread.
    * @fn stop
    */

    virtual void stop();

private:
    /**
    * Listening thread's main function.
    * @fn run
    */
    virtual void run();

private:
    /**
    * #CANObserver instance reference
    * @property mObserver
    * @protected
    */
    CANObserver& mObserver;
    /**
    * @link CANSocket CAN Socket wrapper @endlink instance reference
    * @property mSocket
    * @protected
    */
    CANSocket& mSocket;
};

#endif // CANSOCKETREADER_H

/** @} */