OpenCPN Partial API docs
Loading...
Searching...
No Matches
CommDriverSignalKNet Class Reference
Inheritance diagram for CommDriverSignalKNet:
CommDriverSignalK DriverStatsProvider AbstractCommDriver

Classes

class  IoThread
class  InputEvt

Public Member Functions

 CommDriverSignalKNet (const ConnectionParams *params, DriverListener &l)
DriverStats GetDriverStats () const override
 Get the Driver Statistics.
Public Member Functions inherited from CommDriverSignalK
 CommDriverSignalK (const std::string &s="sk0")
virtual bool SendMessage (std::shared_ptr< const NavMsg > msg, std::shared_ptr< const NavAddr > addr) override
virtual void SetListener (DriverListener &l) override
 Set the entity which will receive incoming data.
virtual std::shared_ptr< NavAddr > GetAddress (const NavAddrSignalK &name)
Public Member Functions inherited from AbstractCommDriver
virtual std::pair< CommStatus, std::string > Clone ()
 Create a new virtual interface using a new instance of this driver.
std::string Key () const
virtual std::unordered_map< std::string, std::string > GetAttributes () const
Public Member Functions inherited from DriverStatsProvider
virtual ~DriverStatsProvider ()=default
 Destroy the Driver Stats Provider object.

Static Public Member Functions

static void initIXNetSystem ()
 ix::initIXNetSystem wrapper
static void uninitIXNetSystem ()
 ix::uninitIXNetSystem wrapper
static bool DiscoverSkServer (const std::string &service_ident, wxString &ip, int &port, int tSec)
 Scan for a SignalK server on local network using mDNS.

Additional Inherited Members

Public Attributes inherited from AbstractCommDriver
const NavAddr::Bus bus
const std::string iface
 Physical device for 0183, else a unique string.
std::unordered_map< std::string, std::string > attributes
Protected Member Functions inherited from AbstractCommDriver
 AbstractCommDriver (NavAddr::Bus b)
 AbstractCommDriver (NavAddr::Bus b, const std::string &s)

Detailed Description

Definition at line 49 of file comm_drv_signalk_net.h.

Constructor & Destructor Documentation

◆ CommDriverSignalKNet()

CommDriverSignalKNet::CommDriverSignalKNet ( const ConnectionParams * params,
DriverListener & l )

Definition at line 186 of file comm_drv_signalk_net.cpp.

◆ ~CommDriverSignalKNet()

CommDriverSignalKNet::~CommDriverSignalKNet ( )
override

Definition at line 209 of file comm_drv_signalk_net.cpp.

Member Function Documentation

◆ DiscoverSkServer()

bool CommDriverSignalKNet::DiscoverSkServer ( const std::string & service_ident,
wxString & ip,
int & port,
int tSec )
static

Scan for a SignalK server on local network using mDNS.

Parameters
service_identmDNS service to scan for
ipOn successful return found server IP address
portOn successful return found server IP port.
tSecScan timeout (seconds).
Returns
true if a server is found, else false.

Definition at line 233 of file comm_drv_signalk_net.cpp.

◆ GetDriverStats()

DriverStats CommDriverSignalKNet::GetDriverStats ( ) const
overridevirtual

Get the Driver Statistics.

Returns
DriverStats Object containing the driver statistics.

Implements DriverStatsProvider.

Definition at line 211 of file comm_drv_signalk_net.cpp.

◆ initIXNetSystem()

void CommDriverSignalKNet::initIXNetSystem ( )
static

ix::initIXNetSystem wrapper

Definition at line 350 of file comm_drv_signalk_net.cpp.

◆ uninitIXNetSystem()

void CommDriverSignalKNet::uninitIXNetSystem ( )
static

ix::uninitIXNetSystem wrapper

Definition at line 352 of file comm_drv_signalk_net.cpp.


The documentation for this class was generated from the following files: