OpenCPN Partial API docs
Loading...
Searching...
No Matches
comm_drv_loopback.h
Go to the documentation of this file.
1/**************************************************************************
2 * Copyright (C) 2025 ALec Leamas *
3 * *
4 * This program is free software; you can redistribute it and/or modify *
5 * it under the terms of the GNU General Public License as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
8 * *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
13 * *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program; if not, see <https://www.gnu.org/licenses/>. *
16 **************************************************************************/
17
24#ifndef _COMM_DRV_LOOPBACK_H
25#define _COMM_DRV_LOOPBACK_H
26
27#include <memory>
28#include <string>
29
30#include "model/comm_driver.h"
31
34public:
36 LoopbackDriver(DriverListener& l) : m_listener(l) {
37 AbstractCommDriver::attributes["protocol"] = "loopback";
38 }
39
40 ~LoopbackDriver() override = default;
41
48 static std::shared_ptr<const NavMsg> ParsePluginMessage(
49 const std::string& msg);
50
52 bool SendMessage(std::shared_ptr<const NavMsg> msg,
53 std::shared_ptr<const NavAddr> addr) override {
54 m_listener.Notify(std::move(msg));
55 return true;
56 }
57
58private:
59 DriverListener& m_listener;
60};
61
62#endif // _COMM_DRV_LOOPBACK_H
Common interface for all drivers.
Definition comm_driver.h:65
Interface for handling incoming messages.
Definition comm_driver.h:50
virtual void Notify(std::shared_ptr< const NavMsg > message)=0
Handle a received message.
Accept messages to send; treat them as received from outside
bool SendMessage(std::shared_ptr< const NavMsg > msg, std::shared_ptr< const NavAddr > addr) override
Accept message to forward to listener; addr is not used.
LoopbackDriver(DriverListener &l)
An instance which accepts messages and forwards it the listener
static std::shared_ptr< const NavMsg > ParsePluginMessage(const std::string &msg)
Parse a string as provided by plugin and convert to a navmsg.
Communication driver layer.