OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
CommDriverSignalKNet Class Reference
Inheritance diagram for CommDriverSignalKNet:
CommDriverSignalK DriverStatsProvider AbstractCommDriver

Public Member Functions

 CommDriverSignalKNet (const ConnectionParams *params, DriverListener &l)
 
void Open ()
 
void Close ()
 
void SetThreadRunning (bool active)
 
void SetThreadRunFlag (int run)
 
void ResetWatchdog ()
 
void SetWatchdog (int n)
 
void handle_SK_sentence (CommDriverSignalKNetEvent &event)
 
void handleUpdate (const rapidjson::Value &update)
 
void updateItem (const rapidjson::Value &item, wxString &sfixtime)
 
void OpenWebSocket ()
 
void CloseWebSocket ()
 
bool IsThreadRunning ()
 
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 bool DiscoverSKServer (wxString &ip, int &port, int tSec)
 
static bool DiscoverSKServer (std::string serviceIdent, wxString &ip, int &port, int tSec)
 
static void initIXNetSystem ()
 
static void uninitIXNetSystem ()
 

Public Attributes

std::string m_self
 
std::string m_context
 
std::atomic_int m_Thread_run_flag
 
std::atomic_int m_threadActive
 
ConnectionParams m_params
 
DriverListener & m_listener
 
- 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
 

Additional Inherited Members

- Protected Member Functions inherited from AbstractCommDriver
 AbstractCommDriver (NavAddr::Bus b)
 
 AbstractCommDriver (NavAddr::Bus b, const std::string &s)
 

Detailed Description

Definition at line 56 of file comm_drv_signalk_net.h.

Constructor & Destructor Documentation

◆ CommDriverSignalKNet()

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

Definition at line 248 of file comm_drv_signalk_net.cpp.

◆ ~CommDriverSignalKNet()

CommDriverSignalKNet::~CommDriverSignalKNet ( )
virtual

Definition at line 274 of file comm_drv_signalk_net.cpp.

Member Function Documentation

◆ Close()

void CommDriverSignalKNet::Close ( )

Definition at line 296 of file comm_drv_signalk_net.cpp.

◆ CloseWebSocket()

void CommDriverSignalKNet::CloseWebSocket ( )

Definition at line 370 of file comm_drv_signalk_net.cpp.

◆ DiscoverSKServer()

bool CommDriverSignalKNet::DiscoverSKServer ( std::string  serviceIdent,
wxString &  ip,
int &  port,
int  tSec 
)
static

Definition at line 298 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 276 of file comm_drv_signalk_net.cpp.

◆ handle_SK_sentence()

void CommDriverSignalKNet::handle_SK_sentence ( CommDriverSignalKNetEvent &  event)

Definition at line 395 of file comm_drv_signalk_net.cpp.

◆ initIXNetSystem()

void CommDriverSignalKNet::initIXNetSystem ( )
static

Definition at line 450 of file comm_drv_signalk_net.cpp.

◆ IsThreadRunning()

bool CommDriverSignalKNet::IsThreadRunning ( )
inline

Definition at line 80 of file comm_drv_signalk_net.h.

◆ Open()

void CommDriverSignalKNet::Open ( )

Definition at line 283 of file comm_drv_signalk_net.cpp.

◆ OpenWebSocket()

void CommDriverSignalKNet::OpenWebSocket ( )

Definition at line 348 of file comm_drv_signalk_net.cpp.

◆ ResetWatchdog()

void CommDriverSignalKNet::ResetWatchdog ( )
inline

Definition at line 71 of file comm_drv_signalk_net.h.

◆ SetThreadRunFlag()

void CommDriverSignalKNet::SetThreadRunFlag ( int  run)
inline

Definition at line 70 of file comm_drv_signalk_net.h.

◆ SetThreadRunning()

void CommDriverSignalKNet::SetThreadRunning ( bool  active)
inline

Definition at line 69 of file comm_drv_signalk_net.h.

◆ SetWatchdog()

void CommDriverSignalKNet::SetWatchdog ( int  n)
inline

Definition at line 72 of file comm_drv_signalk_net.h.

◆ uninitIXNetSystem()

void CommDriverSignalKNet::uninitIXNetSystem ( )
static

Definition at line 452 of file comm_drv_signalk_net.cpp.

Member Data Documentation

◆ m_context

std::string CommDriverSignalKNet::m_context

Definition at line 85 of file comm_drv_signalk_net.h.

◆ m_listener

DriverListener& CommDriverSignalKNet::m_listener

Definition at line 91 of file comm_drv_signalk_net.h.

◆ m_params

ConnectionParams CommDriverSignalKNet::m_params

Definition at line 90 of file comm_drv_signalk_net.h.

◆ m_self

std::string CommDriverSignalKNet::m_self

Definition at line 84 of file comm_drv_signalk_net.h.

◆ m_Thread_run_flag

std::atomic_int CommDriverSignalKNet::m_Thread_run_flag

Definition at line 87 of file comm_drv_signalk_net.h.

◆ m_threadActive

std::atomic_int CommDriverSignalKNet::m_threadActive

Definition at line 88 of file comm_drv_signalk_net.h.

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