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

Public Member Functions

 CommDriverN2KNet (const ConnectionParams *params, DriverListener &listener)
 
DriverStats GetDriverStats () const override
 Get the Driver Statistics.
 
void SetListener (DriverListener &l) override
 Set the entity which will receive incoming data.
 
void Open ()
 
void Close ()
 
ConnectionParams GetParams () const
 
bool SetOutputSocketOptions (wxSocketBase *tsock)
 
void OnServerSocketEvent (wxSocketEvent &event)
 
void OnTimerSocket (wxTimerEvent &event)
 
void OnTimerSocket ()
 
void OnSocketEvent (wxSocketEvent &event)
 
void OpenNetworkGPSD ()
 
void OpenNetworkTCP (unsigned int addr)
 
void OpenNetworkUDP (unsigned int addr)
 
void OnSocketReadWatchdogTimer (wxTimerEvent &event)
 
void HandleResume ()
 
bool SendMessage (std::shared_ptr< const NavMsg > msg, std::shared_ptr< const NavAddr > addr) override
 
wxSocketBase * GetSock () const
 
- Public Member Functions inherited from CommDriverN2K
 CommDriverN2K (const std::string &s="n2k0")
 
virtual std::shared_ptr< NavAddr2000 > GetAddress (const N2kName &name)
 
virtual int SetTXPGN (int pgn)
 
- 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.
 

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 103 of file comm_drv_n2k_net.h.

Constructor & Destructor Documentation

◆ CommDriverN2KNet()

CommDriverN2KNet::CommDriverN2KNet ( const ConnectionParams *  params,
DriverListener &  listener 
)

Definition at line 187 of file comm_drv_n2k_net.cpp.

◆ ~CommDriverN2KNet()

CommDriverN2KNet::~CommDriverN2KNet ( )
virtual

Definition at line 246 of file comm_drv_n2k_net.cpp.

Member Function Documentation

◆ Close()

void CommDriverN2KNet::Close ( )

Definition at line 1994 of file comm_drv_n2k_net.cpp.

◆ GetDriverStats()

DriverStats CommDriverN2KNet::GetDriverStats ( ) const
inlineoverridevirtual

Get the Driver Statistics.

Returns
DriverStats Object containing the driver statistics.

Implements DriverStatsProvider.

Definition at line 112 of file comm_drv_n2k_net.h.

◆ GetParams()

ConnectionParams CommDriverN2KNet::GetParams ( ) const
inline

Definition at line 118 of file comm_drv_n2k_net.h.

◆ GetSock()

wxSocketBase * CommDriverN2KNet::GetSock ( ) const
inline

Definition at line 133 of file comm_drv_n2k_net.h.

◆ HandleResume()

void CommDriverN2KNet::HandleResume ( )

Definition at line 482 of file comm_drv_n2k_net.cpp.

◆ OnServerSocketEvent()

void CommDriverN2KNet::OnServerSocketEvent ( wxSocketEvent &  event)

Definition at line 1410 of file comm_drv_n2k_net.cpp.

◆ OnSocketEvent()

void CommDriverN2KNet::OnSocketEvent ( wxSocketEvent &  event)

start the DATA watchdog only if NODATA Reconnect is desired

Definition at line 1262 of file comm_drv_n2k_net.cpp.

◆ OnSocketReadWatchdogTimer()

void CommDriverN2KNet::OnSocketReadWatchdogTimer ( wxTimerEvent &  event)

Definition at line 442 of file comm_drv_n2k_net.cpp.

◆ OnTimerSocket() [1/2]

void CommDriverN2KNet::OnTimerSocket ( )

Definition at line 464 of file comm_drv_n2k_net.cpp.

◆ OnTimerSocket() [2/2]

void CommDriverN2KNet::OnTimerSocket ( wxTimerEvent &  event)
inline

Definition at line 122 of file comm_drv_n2k_net.h.

◆ Open()

void CommDriverN2KNet::Open ( )

Definition at line 331 of file comm_drv_n2k_net.cpp.

◆ OpenNetworkTCP()

void CommDriverN2KNet::OpenNetworkTCP ( unsigned int  addr)

Definition at line 410 of file comm_drv_n2k_net.cpp.

◆ OpenNetworkUDP()

void CommDriverN2KNet::OpenNetworkUDP ( unsigned int  addr)

Definition at line 359 of file comm_drv_n2k_net.cpp.

◆ SendMessage()

bool CommDriverN2KNet::SendMessage ( std::shared_ptr< const NavMsg >  msg,
std::shared_ptr< const NavAddr >  addr 
)
overridevirtual

Implements CommDriverN2K.

Definition at line 499 of file comm_drv_n2k_net.cpp.

◆ SetListener()

void CommDriverN2KNet::SetListener ( DriverListener &  l)
inlineoverridevirtual

Set the entity which will receive incoming data.

By default, such data is ignored

Reimplemented from CommDriverN2K.

Definition at line 114 of file comm_drv_n2k_net.h.

◆ SetOutputSocketOptions()

bool CommDriverN2KNet::SetOutputSocketOptions ( wxSocketBase *  tsock)

Definition at line 2022 of file comm_drv_n2k_net.cpp.

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