A plugin to plugin json message over the REST interface. More...
#include <comm_navmsg.h>
Public Member Functions | |
| PluginMsg (const std::string &_name, const std::string &_dest_host, const std::string &msg) | |
| PluginMsg (const std::string &_name, const std::string &msg) | |
| std::string | key () const |
| Return unique key used by observable to notify/listen. | |
| std::string | to_string () const |
| Return printable string for logging etc without trailing nl. | |
 Public Member Functions inherited from NavMsg | |
| virtual std::string | to_vdr () const |
| Return message in unquoted format used by VDR plugin, see https://opencpn-manuals.github.io/main/vdr/log_format.html. | |
| std::string | GetKey () const |
| Alias for key(). | |
Public Attributes | |
| const std::string | name |
| const std::string | message |
| const std::string | dest_host |
| hostname, ip address or 'localhost' | |
| Public Attributes inherited from NavMsg | |
| const NavAddr::Bus | bus |
| std::shared_ptr< const NavAddr > | source |
| Source address is set by drivers when receiving, unused and should be empty when sending. | |
| const NavmsgTimePoint | created_at |
Additional Inherited Members | |
| Protected Member Functions inherited from NavMsg | |
| NavMsg (const NavAddr::Bus &_bus, std::shared_ptr< const NavAddr > src) | |
Detailed Description
A plugin to plugin json message over the REST interface.
Definition at line 344 of file comm_navmsg.h.
Constructor & Destructor Documentation
◆ PluginMsg() [1/3]
|
inline |
Definition at line 346 of file comm_navmsg.h.
◆ PluginMsg() [2/3]
|
inline |
Definition at line 349 of file comm_navmsg.h.
◆ PluginMsg() [3/3]
|
inline |
Definition at line 357 of file comm_navmsg.h.
Member Function Documentation
◆ key()
|
inlinevirtual |
Return unique key used by observable to notify/listen.
Implements NavMsg.
Definition at line 362 of file comm_navmsg.h.
◆ to_string()
|
virtual |
Return printable string for logging etc without trailing nl.
Avoid messing with utf string.
Reimplemented from NavMsg.
Definition at line 142 of file comm_navmsg.cpp.
Member Data Documentation
◆ dest_host
| const std::string PluginMsg::dest_host |
hostname, ip address or 'localhost'
Definition at line 368 of file comm_navmsg.h.
◆ message
| const std::string PluginMsg::message |
Definition at line 367 of file comm_navmsg.h.
◆ name
| const std::string PluginMsg::name |
Definition at line 366 of file comm_navmsg.h.
The documentation for this class was generated from the following files:
- /home/runner/work/main/main/opencpn/model/include/model/comm_navmsg.h
- /home/runner/work/main/main/opencpn/model/src/comm_navmsg.cpp
