OpenCPN Partial API docs
comm_drv_n2k_socketcan.h
1 /***************************************************************************
2  *
3  * Project: OpenCPN
4  * Purpose: Low-level driver for socketcan devices (linux only).
5  * Author: David Register, Alec Leamas
6  *
7  ***************************************************************************
8  * Copyright (C) 2022 by David Register, Alec Leamas *
9  * *
10  * This program is free software; you can redistribute it and/or modify *
11  * it under the terms of the GNU General Public License as published by *
12  * the Free Software Foundation; either version 2 of the License, or *
13  * (at your option) any later version. *
14  * *
15  * This program is distributed in the hope that it will be useful, *
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
18  * GNU General Public License for more details. *
19  * *
20  * You should have received a copy of the GNU General Public License *
21  * along with this program; if not, write to the *
22  * Free Software Foundation, Inc., *
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
24  **************************************************************************/
25 
26 #ifndef _COMMDRIVERN2KSOCKETCAN_H
27 #define _COMMDRIVERN2KSOCKETCAN_H
28 
29 #include <memory>
30 #include <string>
31 
32 #include "model/comm_drv_n2k.h"
33 #include "model/conn_params.h"
34 
36 public:
37  static std::shared_ptr<CommDriverN2KSocketCAN> Create(
38  const ConnectionParams* params, DriverListener& listener);
39 
40  virtual ~CommDriverN2KSocketCAN();
41 
43  void Activate() override;
44 
45  void SetListener(DriverListener& l) override { m_listener = l; }
46 
47  bool SendMessage(std::shared_ptr<const NavMsg> msg,
48  std::shared_ptr<const NavAddr> addr) = 0; //override;
49 
50  virtual bool Open() = 0;
51  virtual void Close() = 0;
52 
53  void UpdateAttrCanAddress();
54 
55 protected:
57  DriverListener& listener);
58  ConnectionParams m_params;
59  DriverListener& m_listener;
60 
61 private:
62  bool m_ok;
63  std::string m_portstring;
64  std::string m_baudrate;
65 };
66 
67 #endif // guard
void SetListener(DriverListener &l) override
Set the entity which will receive incoming data.
void Activate() override
Register driver and possibly do other post-ctor steps.
Interface implemented by transport layer and possible other parties like test code which should handl...
Definition: comm_driver.h:47