OpenCPN Partial API docs
Loading...
Searching...
No Matches
CommDriverN2KSocketCanImpl Class Reference

Local driver implementation, not visible outside this file. More...

Inheritance diagram for CommDriverN2KSocketCanImpl:
CommDriverN2KSocketCAN CommDriverN2K AbstractCommDriver

Public Member Functions

 CommDriverN2KSocketCanImpl (const ConnectionParams *p, DriverListener &l)
 
bool Open ()
 
void Close ()
 
void SetN2K_Name ()
 
bool SendMessage (std::shared_ptr< const NavMsg > msg, std::shared_ptr< const NavAddr > addr)
 
int DoAddressClaim ()
 
bool SendAddressClaim (int proposed_source_address)
 
WorkerGetWorker ()
 
- Public Member Functions inherited from CommDriverN2KSocketCAN
void Activate () override
 Register driver and possibly do other post-ctor steps. More...
 
void SetListener (DriverListener &l) override
 Set the entity which will receive incoming data. More...
 
bool SendMessage (std::shared_ptr< const NavMsg > msg, std::shared_ptr< const NavAddr > addr)=0
 
virtual bool Open ()=0
 
virtual void Close ()=0
 
- Public Member Functions inherited from CommDriverN2K
 CommDriverN2K (const std::string &s="n2k0")
 
virtual bool SendMessage (std::shared_ptr< const NavMsg > msg, std::shared_ptr< const NavAddr > addr)=0
 
virtual void SetListener (DriverListener &l) override
 Set the entity which will receive incoming data. More...
 
virtual std::shared_ptr< NavAddrGetAddress (const N2kName &name)
 
virtual int SetTXPGN (int pgn)
 
- Public Member Functions inherited from AbstractCommDriver
virtual bool SendMessage (std::shared_ptr< const NavMsg > msg, std::shared_ptr< const NavAddr > addr)=0
 
virtual void Activate ()=0
 Register driver in the driver Registry. More...
 
virtual void SetListener (DriverListener &l)
 Set the entity which will receive incoming data. More...
 
virtual std::pair< CommStatus, std::string > Clone ()
 Create a new virtual interface using a new instance of this driver. More...
 
std::string Key () const
 
virtual std::unordered_map< std::string, std::string > GetAttributes () const
 

Friends

class Worker
 

Additional Inherited Members

- Static Public Member Functions inherited from CommDriverN2KSocketCAN
static std::shared_ptr< CommDriverN2KSocketCANCreate (const ConnectionParams *params, DriverListener &listener)
 
- Public Attributes inherited from AbstractCommDriver
const NavAddr::Bus bus
 
const std::string iface
 Physical device for 0183, else a unique string. More...
 
std::unordered_map< std::string, std::string > attributes
 
- Protected Member Functions inherited from CommDriverN2KSocketCAN
 CommDriverN2KSocketCAN (const ConnectionParams *params, DriverListener &listener)
 
- Protected Member Functions inherited from AbstractCommDriver
 AbstractCommDriver (NavAddr::Bus b)
 
 AbstractCommDriver (NavAddr::Bus b, const std::string &s)
 
- Protected Attributes inherited from CommDriverN2KSocketCAN
ConnectionParams m_params
 
DriverListenerm_listener
 

Detailed Description

Local driver implementation, not visible outside this file.

Definition at line 236 of file comm_drv_n2k_socketcan.cpp.

Constructor & Destructor Documentation

◆ CommDriverN2KSocketCanImpl()

CommDriverN2KSocketCanImpl::CommDriverN2KSocketCanImpl ( const ConnectionParams p,
DriverListener l 
)
inline

Definition at line 240 of file comm_drv_n2k_socketcan.cpp.

◆ ~CommDriverN2KSocketCanImpl()

CommDriverN2KSocketCanImpl::~CommDriverN2KSocketCanImpl ( )
inline

Definition at line 247 of file comm_drv_n2k_socketcan.cpp.

Member Function Documentation

◆ Close()

void CommDriverN2KSocketCanImpl::Close ( )
virtual

Implements CommDriverN2KSocketCAN.

Definition at line 357 of file comm_drv_n2k_socketcan.cpp.

◆ GetWorker()

Worker & CommDriverN2KSocketCanImpl::GetWorker ( )
inline

Definition at line 259 of file comm_drv_n2k_socketcan.cpp.

◆ Open()

bool CommDriverN2KSocketCanImpl::Open ( )
virtual

Implements CommDriverN2KSocketCAN.

Definition at line 349 of file comm_drv_n2k_socketcan.cpp.

◆ SendAddressClaim()

bool CommDriverN2KSocketCanImpl::SendAddressClaim ( int  proposed_source_address)

Definition at line 368 of file comm_drv_n2k_socketcan.cpp.

◆ SendMessage()

bool CommDriverN2KSocketCanImpl::SendMessage ( std::shared_ptr< const NavMsg msg,
std::shared_ptr< const NavAddr addr 
)
virtual

Implements CommDriverN2KSocketCAN.

Definition at line 407 of file comm_drv_n2k_socketcan.cpp.

◆ SetN2K_Name()

void CommDriverN2KSocketCanImpl::SetN2K_Name ( )

Definition at line 327 of file comm_drv_n2k_socketcan.cpp.

Friends And Related Function Documentation

◆ Worker

friend class Worker
friend

Definition at line 237 of file comm_drv_n2k_socketcan.cpp.


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